<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>JdbcGenericDao xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: JdbcGenericDao.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html $</em>
<a name="4" href="#4">4</a>   <em> * JdbcGenericDao.java - genericdao - Apr 18, 2008 10:07:08 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.springjdbc;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.io.BufferedReader;
<a name="18" href="#18">18</a>  <strong>import</strong> java.io.ByteArrayInputStream;
<a name="19" href="#19">19</a>  <strong>import</strong> java.io.IOException;
<a name="20" href="#20">20</a>  <strong>import</strong> java.io.InputStream;
<a name="21" href="#21">21</a>  <strong>import</strong> java.io.InputStreamReader;
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.Serializable;
<a name="23" href="#23">23</a>  <strong>import</strong> java.lang.annotation.Annotation;
<a name="24" href="#24">24</a>  <strong>import</strong> java.sql.Connection;
<a name="25" href="#25">25</a>  <strong>import</strong> java.sql.SQLException;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.ArrayList;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.HashMap;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Iterator;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.List;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.Map;
<a name="31" href="#31">31</a>  <strong>import</strong> java.util.Vector;
<a name="32" href="#32">32</a>  <strong>import</strong> java.util.Map.Entry;
<a name="33" href="#33">33</a>  <strong>import</strong> java.util.concurrent.ConcurrentHashMap;
<a name="34" href="#34">34</a>  
<a name="35" href="#35">35</a>  <strong>import</strong> javax.sql.DataSource;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>  <strong>import</strong> org.azeckoski.reflectutils.ArrayUtils;
<a name="38" href="#38">38</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields;
<a name="39" href="#39">39</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="40" href="#40">40</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields.FieldsFilter;
<a name="41" href="#41">41</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldnameNotFoundException;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.genericdao.api.GenericDao;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.PersistentColumnMappingPolicy;
<a name="44" href="#44">44</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.PersistentColumnName;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.PersistentId;
<a name="46" href="#46">46</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.PersistentTransient;
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.genericdao.api.annotations.enums.MappingPolicy;
<a name="48" href="#48">48</a>  <strong>import</strong> org.sakaiproject.genericdao.api.caching.CacheProvider;
<a name="49" href="#49">49</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.DaoOperationInterceptor;
<a name="50" href="#50">50</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.ReadInterceptor;
<a name="51" href="#51">51</a>  <strong>import</strong> org.sakaiproject.genericdao.api.interceptors.WriteInterceptor;
<a name="52" href="#52">52</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.DataMapper;
<a name="53" href="#53">53</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.EntityColumnMapper;
<a name="54" href="#54">54</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.NamesRecord;
<a name="55" href="#55">55</a>  <strong>import</strong> org.sakaiproject.genericdao.api.mappers.StatementMapper;
<a name="56" href="#56">56</a>  <strong>import</strong> org.sakaiproject.genericdao.api.search.Search;
<a name="57" href="#57">57</a>  <strong>import</strong> org.sakaiproject.genericdao.api.translators.DatabaseTranslator;
<a name="58" href="#58">58</a>  <strong>import</strong> org.sakaiproject.genericdao.base.caching.NonCachingCacheProvider;
<a name="59" href="#59">59</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.BasicTranslator;
<a name="60" href="#60">60</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.DB2Translator;
<a name="61" href="#61">61</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.DerbyTranslator;
<a name="62" href="#62">62</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.HSQLDBTranslator;
<a name="63" href="#63">63</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.MSSQLTranslator;
<a name="64" href="#64">64</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.MySQLTranslator;
<a name="65" href="#65">65</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.OracleTranslator;
<a name="66" href="#66">66</a>  <strong>import</strong> org.sakaiproject.genericdao.springjdbc.translators.PostgresTranslator;
<a name="67" href="#67">67</a>  <strong>import</strong> org.sakaiproject.genericdao.springutil.SmartDataSourceWrapper;
<a name="68" href="#68">68</a>  <strong>import</strong> org.sakaiproject.genericdao.util.JDBCUtils;
<a name="69" href="#69">69</a>  <strong>import</strong> org.sakaiproject.genericdao.util.ThreadboundConnectionsDataSourceWrapper;
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>  <strong>import</strong> org.springframework.dao.DataAccessException;
<a name="72" href="#72">72</a>  <strong>import</strong> org.springframework.dao.IncorrectResultSizeDataAccessException;
<a name="73" href="#73">73</a>  <strong>import</strong> org.springframework.jdbc.CannotGetJdbcConnectionException;
<a name="74" href="#74">74</a>  <strong>import</strong> org.springframework.jdbc.core.JdbcTemplate;
<a name="75" href="#75">75</a>  <strong>import</strong> org.springframework.jdbc.core.support.JdbcDaoSupport;
<a name="76" href="#76">76</a>  <strong>import</strong> org.springframework.jdbc.datasource.DataSourceUtils;
<a name="77" href="#77">77</a>  <strong>import</strong> org.springframework.jdbc.datasource.SmartDataSource;
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>  <em>/**<em>*</em></em>
<a name="80" href="#80">80</a>  <em> * A Spring JDBC (<a href="http://hibernate.org/)" target="alexandria_uri">http://hibernate.org/)</a> based implementation of GenericDao</em>
<a name="81" href="#81">81</a>  <em> * which can be extended to add more specialized DAO methods.</em>
<a name="82" href="#82">82</a>  <em> * &lt;p></em>
<a name="83" href="#83">83</a>  <em> * Note: This implementation is so simple it is unlikely to be useful</em>
<a name="84" href="#84">84</a>  <em> * &lt;p></em>
<a name="85" href="#85">85</a>  <em> * See the overview for installation/usage tips.</em>
<a name="86" href="#86">86</a>  <em> * </em>
<a name="87" href="#87">87</a>  <em> * @author Aaron Zeckoski (azeckoski@gmail.com)</em>
<a name="88" href="#88">88</a>  <em> */</em>
<a name="89" href="#89">89</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html">JdbcGenericDao</a> <strong>extends</strong> JdbcDaoSupport implements <a href="../../../../org/sakaiproject/genericdao/api/GenericDao.html">GenericDao</a> {
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <strong>private</strong> String databaseType = DataMapper.DBTYPE_HSQLDB;
<a name="92" href="#92">92</a>      <em>/**<em>*</em></em>
<a name="93" href="#93">93</a>  <em>     * This should be set to the type of database being used</em>
<a name="94" href="#94">94</a>  <em>     * and determines which DDL to run when creating the tables,</em>
<a name="95" href="#95">95</a>  <em>     * defaults to {@link DataMapper#DBTYPE_HSQLDB} "HSQLDB",</em>
<a name="96" href="#96">96</a>  <em>     * will fixup case as needed</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>public</strong> <strong>void</strong> setDatabaseType(String databaseType) {
<a name="99" href="#99">99</a>          <strong>if</strong> (databaseType == <strong>null</strong> || databaseType.length() == 0) {
<a name="100" href="#100">100</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"databaseType cannot be null or empty"</span>);
<a name="101" href="#101">101</a>         }
<a name="102" href="#102">102</a>         <strong>if</strong> (DatabaseTranslator.DBTYPE_DB2.equalsIgnoreCase(databaseType)) {
<a name="103" href="#103">103</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_DB2;
<a name="104" href="#104">104</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_DERBY.equalsIgnoreCase(databaseType)) {
<a name="105" href="#105">105</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_DERBY;
<a name="106" href="#106">106</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_HSQLDB.equalsIgnoreCase(databaseType)) {
<a name="107" href="#107">107</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_HSQLDB;
<a name="108" href="#108">108</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_MSSQL.equalsIgnoreCase(databaseType)) {
<a name="109" href="#109">109</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_MSSQL;
<a name="110" href="#110">110</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_MYSQL.equalsIgnoreCase(databaseType)) {
<a name="111" href="#111">111</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_MYSQL;
<a name="112" href="#112">112</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_ORACLE.equalsIgnoreCase(databaseType)) {
<a name="113" href="#113">113</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_ORACLE;
<a name="114" href="#114">114</a>         } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_POSTGRES.equalsIgnoreCase(databaseType)) {
<a name="115" href="#115">115</a>             <strong>this</strong>.databaseType = DatabaseTranslator.DBTYPE_POSTGRES;
<a name="116" href="#116">116</a>         } <strong>else</strong> {
<a name="117" href="#117">117</a>             <strong>this</strong>.databaseType = databaseType.toUpperCase();
<a name="118" href="#118">118</a>         }
<a name="119" href="#119">119</a>     }
<a name="120" href="#120">120</a>     <em>/**<em>*</em></em>
<a name="121" href="#121">121</a> <em>     * @return a constant indicating the type of database: DBTYPE_*</em>
<a name="122" href="#122">122</a> <em>     */</em>
<a name="123" href="#123">123</a>     <strong>protected</strong> String getDatabaseType() {
<a name="124" href="#124">124</a>         <strong>return</strong> databaseType;
<a name="125" href="#125">125</a>     }
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <em>/**<em>*</em></em>
<a name="128" href="#128">128</a> <em>     * @return the jdbcTemplate that is currently in use,</em>
<a name="129" href="#129">129</a> <em>     * allows for overriding and support DAO-4 (<a href="http://jira.sakaiproject.org/jira/browse/DAO-4)" target="alexandria_uri">http://jira.sakaiproject.org/jira/browse/DAO-4)</a></em>
<a name="130" href="#130">130</a> <em>     */</em>
<a name="131" href="#131">131</a>     <strong>public</strong> JdbcTemplate getSpringJdbcTemplate() {
<a name="132" href="#132">132</a>         <strong>return</strong> <strong>super</strong>.getJdbcTemplate();
<a name="133" href="#133">133</a>     }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>     <strong>protected</strong> <strong>boolean</strong> showSQL = false;
<a name="136" href="#136">136</a>     <em>/**<em>*</em></em>
<a name="137" href="#137">137</a> <em>     * Enable SQL debugging which will show all SQL statements and DDL statements being executed by printing them out</em>
<a name="138" href="#138">138</a> <em>     * </em>
<a name="139" href="#139">139</a> <em>     * @param showSQL if true then all SQL and DDL statements will be printed</em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     <strong>public</strong> <strong>void</strong> setShowSQL(<strong>boolean</strong> showSQL) {
<a name="142" href="#142">142</a>         <strong>this</strong>.showSQL = showSQL;
<a name="143" href="#143">143</a>     }
<a name="144" href="#144">144</a>     <em>/**<em>*</em></em>
<a name="145" href="#145">145</a> <em>     * @return true if show SQL is enabled, not a good idea for production</em>
<a name="146" href="#146">146</a> <em>     */</em>
<a name="147" href="#147">147</a>     <strong>public</strong> <strong>boolean</strong> isShowSQL() {
<a name="148" href="#148">148</a>         <strong>return</strong> showSQL;
<a name="149" href="#149">149</a>     }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>     <strong>private</strong> <strong>boolean</strong> autoDDL = <strong>true</strong>;
<a name="152" href="#152">152</a>     <em>/**<em>*</em></em>
<a name="153" href="#153">153</a> <em>     * @return true if automatic DDL execution is enabled</em>
<a name="154" href="#154">154</a> <em>     */</em>
<a name="155" href="#155">155</a>     <strong>public</strong> <strong>boolean</strong> isAutoDDL() {
<a name="156" href="#156">156</a>         <strong>return</strong> autoDDL;
<a name="157" href="#157">157</a>     }
<a name="158" href="#158">158</a>     <em>/**<em>*</em></em>
<a name="159" href="#159">159</a> <em>     * Set to true to cause defined DDL to be executed</em>
<a name="160" href="#160">160</a> <em>     * </em>
<a name="161" href="#161">161</a> <em>     * @param autoDDL set to true to cause the DDL to be executed,</em>
<a name="162" href="#162">162</a> <em>     * if false then no DDL will be executed</em>
<a name="163" href="#163">163</a> <em>     */</em>
<a name="164" href="#164">164</a>     <strong>public</strong> <strong>void</strong> setAutoDDL(<strong>boolean</strong> autoDDL) {
<a name="165" href="#165">165</a>         <strong>this</strong>.autoDDL = autoDDL;
<a name="166" href="#166">166</a>     }
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>     <strong>private</strong> <strong>boolean</strong> autoCommitDDL = false;
<a name="169" href="#169">169</a>     <em>/**<em>*</em></em>
<a name="170" href="#170">170</a> <em>     * @return true if DDL automatic commits are enabled</em>
<a name="171" href="#171">171</a> <em>     */</em>
<a name="172" href="#172">172</a>     <strong>public</strong> <strong>boolean</strong> isAutoCommitDDL() {
<a name="173" href="#173">173</a>         <strong>return</strong> autoCommitDDL;
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a>     <em>/**<em>*</em></em>
<a name="176" href="#176">176</a> <em>     * Allows control over whether the DDL should be committed after each statement as it is read in,</em>
<a name="177" href="#177">177</a> <em>     * this should probably be disabled if you are using a transaction manager and should be enabled if</em>
<a name="178" href="#178">178</a> <em>     * you are managing your own transactions</em>
<a name="179" href="#179">179</a> <em>     * </em>
<a name="180" href="#180">180</a> <em>     * @param autoCommitDDL true to enable auto commits on DDL excecution</em>
<a name="181" href="#181">181</a> <em>     */</em>
<a name="182" href="#182">182</a>     <strong>public</strong> <strong>void</strong> setAutoCommitDDL(<strong>boolean</strong> autoCommitDDL) {
<a name="183" href="#183">183</a>         <strong>this</strong>.autoCommitDDL = autoCommitDDL;
<a name="184" href="#184">184</a>     }
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>     <strong>private</strong> <strong>boolean</strong> autoCommitOperations = false;
<a name="187" href="#187">187</a>     <em>/**<em>*</em></em>
<a name="188" href="#188">188</a> <em>     * @return true if automatic commit is enabled for all generic DAO write operations</em>
<a name="189" href="#189">189</a> <em>     */</em>
<a name="190" href="#190">190</a>     <strong>public</strong> <strong>boolean</strong> isAutoCommitOperations() {
<a name="191" href="#191">191</a>         <strong>return</strong> autoCommitOperations;
<a name="192" href="#192">192</a>     }
<a name="193" href="#193">193</a>     <em>/**<em>*</em></em>
<a name="194" href="#194">194</a> <em>     * Allows control over whether the DAO should do automatic commits for all generic DAO write operations</em>
<a name="195" href="#195">195</a> <em>     * </em>
<a name="196" href="#196">196</a> <em>     * @param autoCommitOperations true to enable automatic commits for all generic dao operations,</em>
<a name="197" href="#197">197</a> <em>     * this should be false if you are using a transaction manager</em>
<a name="198" href="#198">198</a> <em>     */</em>
<a name="199" href="#199">199</a>     <strong>public</strong> <strong>void</strong> setAutoCommitOperations(<strong>boolean</strong> autoCommitOperations) {
<a name="200" href="#200">200</a>         <strong>this</strong>.autoCommitOperations = autoCommitOperations;
<a name="201" href="#201">201</a>     }
<a name="202" href="#202">202</a> 
<a name="203" href="#203">203</a>     <em>/**<em>*</em></em>
<a name="204" href="#204">204</a> <em>     * This is a special case DataSource setter method which will wrap the DataSource,</em>
<a name="205" href="#205">205</a> <em>     * you must use this in the case where the {@link DataSource} you are using is not</em>
<a name="206" href="#206">206</a> <em>     * a Spring controlled on {@link SmartDataSource}, this will wrap the spring</em>
<a name="207" href="#207">207</a> <em>     * DataSource automatically so that the auto-commit and manual transactions will work,</em>
<a name="208" href="#208">208</a> <em>     * without this wrapper your connections will be closed after each jdbcTemplate method runs</em>
<a name="209" href="#209">209</a> <em>     * and nothing will ever be committed (unless the connection is set to auto-commit) &lt;br/></em>
<a name="210" href="#210">210</a> <em>     * WARNING: if you use this then you are responsible for committing TXs and closing your connections </em>
<a name="211" href="#211">211</a> <em>     * using the {@link #closeConnection()} and {@link #commitTransaction()} or {@link #rollbackTransaction()}</em>
<a name="212" href="#212">212</a> <em>     * methods &lt;br/></em>
<a name="213" href="#213">213</a> <em>     * Is not thread-bound</em>
<a name="214" href="#214">214</a> <em>     * @see #setNonSpringDataSource(DataSource, boolean)</em>
<a name="215" href="#215">215</a> <em>     * </em>
<a name="216" href="#216">216</a> <em>     * @param dataSource any non-spring {@link DataSource}</em>
<a name="217" href="#217">217</a> <em>     */</em>
<a name="218" href="#218">218</a>     <strong>public</strong> <strong>void</strong> setNonSpringDataSource(DataSource dataSource) {
<a name="219" href="#219">219</a>         setNonSpringDataSource(dataSource, false);
<a name="220" href="#220">220</a>     }
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a>     <em>/**<em>*</em></em>
<a name="223" href="#223">223</a> <em>     * This is a special case DataSource setter method which will wrap the DataSource,</em>
<a name="224" href="#224">224</a> <em>     * you must use this in the case where the {@link DataSource} you are using is not</em>
<a name="225" href="#225">225</a> <em>     * a Spring controlled on {@link SmartDataSource}, this will wrap the spring</em>
<a name="226" href="#226">226</a> <em>     * DataSource automatically so that the auto-commit and manual transactions will work,</em>
<a name="227" href="#227">227</a> <em>     * without this wrapper your connections will be closed after each jdbcTemplate method runs</em>
<a name="228" href="#228">228</a> <em>     * and nothing will ever be committed (unless the connection is set to auto-commit) &lt;br/></em>
<a name="229" href="#229">229</a> <em>     * WARNING: if you use this then you are responsible for committing TXs and closing your connections </em>
<a name="230" href="#230">230</a> <em>     * using the {@link #closeConnection()} and {@link #commitTransaction()} or {@link #rollbackTransaction()}</em>
<a name="231" href="#231">231</a> <em>     * methods</em>
<a name="232" href="#232">232</a> <em>     * </em>
<a name="233" href="#233">233</a> <em>     * @param dataSource any non-spring {@link DataSource}</em>
<a name="234" href="#234">234</a> <em>     * @param threadBound if true then the connections will be thread-bound and only one returned</em>
<a name="235" href="#235">235</a> <em>     * for the current thread no matter how many times getConnection is called, </em>
<a name="236" href="#236">236</a> <em>     * if false then they will return a new connection for each call</em>
<a name="237" href="#237">237</a> <em>     */</em>
<a name="238" href="#238">238</a>     <strong>public</strong> <strong>void</strong> setNonSpringDataSource(DataSource dataSource, <strong>boolean</strong> threadBound) {
<a name="239" href="#239">239</a>         <strong>if</strong> (dataSource == <strong>null</strong>) {
<a name="240" href="#240">240</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"dataSource cannot be null"</span>);
<a name="241" href="#241">241</a>         }
<a name="242" href="#242">242</a>         <strong>if</strong> (dataSource instanceof SmartDataSource) {
<a name="243" href="#243">243</a>             setDataSource(dataSource);
<a name="244" href="#244">244</a>         } <strong>else</strong> {
<a name="245" href="#245">245</a>             <em class="comment">// wrap it up</em>
<a name="246" href="#246">246</a>             DataSource wrapper = dataSource;
<a name="247" href="#247">247</a>             <strong>if</strong> (threadBound) {
<a name="248" href="#248">248</a>                 wrapper = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/util/ThreadboundConnectionsDataSourceWrapper.html">ThreadboundConnectionsDataSourceWrapper</a>(wrapper);
<a name="249" href="#249">249</a>             }
<a name="250" href="#250">250</a>             wrapper = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springutil/SmartDataSourceWrapper.html">SmartDataSourceWrapper</a>(wrapper);
<a name="251" href="#251">251</a>             setDataSource( wrapper );
<a name="252" href="#252">252</a>         }
<a name="253" href="#253">253</a>     }
<a name="254" href="#254">254</a> 
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>     <em>/**<em>*</em></em>
<a name="257" href="#257">257</a> <em>     * preserve the order the classes are read in, </em>
<a name="258" href="#258">258</a> <em>     * presumably this is also the dependency order </em>
<a name="259" href="#259">259</a> <em>     */</em>
<a name="260" href="#260">260</a>     <strong>private</strong> Map&lt;Class&lt;?>, DataMapper> dataMappers;
<a name="261" href="#261">261</a>     <em>/**<em>*</em></em>
<a name="262" href="#262">262</a> <em>     * This tells the DAO about your persistent classes and their associated tables,</em>
<a name="263" href="#263">263</a> <em>     * it is the major configuration path for the DAO</em>
<a name="264" href="#264">264</a> <em>     * @param dataMappers a list of all {@link DataMapper}s that this DAO uses,</em>
<a name="265" href="#265">265</a> <em>     * ideally this is no more than a few per DAO but it should include all tables which are directly linked</em>
<a name="266" href="#266">266</a> <em>     */</em>
<a name="267" href="#267">267</a>     <strong>public</strong> <strong>void</strong> setDataMappers(List&lt;DataMapper> dataMappers) {
<a name="268" href="#268">268</a>         <strong>if</strong> (<strong>this</strong>.dataMappers == <strong>null</strong>) {
<a name="269" href="#269">269</a>             <strong>this</strong>.dataMappers = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, DataMapper>();
<a name="270" href="#270">270</a>             <strong>this</strong>.classes = <strong>new</strong> Vector&lt;Class&lt;?>>();
<a name="271" href="#271">271</a>         }
<a name="272" href="#272">272</a>         <strong>for</strong> (DataMapper dataMapper : dataMappers) {
<a name="273" href="#273">273</a>             Class&lt;?> type = dataMapper.getPersistentType();
<a name="274" href="#274">274</a>             <strong>this</strong>.dataMappers.put(type, dataMapper);
<a name="275" href="#275">275</a>             <strong>this</strong>.classes.add(type);
<a name="276" href="#276">276</a>             getNamesRecord(type); <em class="comment">// prime the names record</em>
<a name="277" href="#277">277</a>         }
<a name="278" href="#278">278</a>     }
<a name="279" href="#279">279</a> 
<a name="280" href="#280">280</a>     <em>/**<em>*</em></em>
<a name="281" href="#281">281</a> <em>     * Get a data mapper for a specific class,</em>
<a name="282" href="#282">282</a> <em>     * will always return a data mapper</em>
<a name="283" href="#283">283</a> <em>     */</em>
<a name="284" href="#284">284</a>     <strong>protected</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> getDataMapper(Class&lt;?> type) {
<a name="285" href="#285">285</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = dataMappers.get(type);
<a name="286" href="#286">286</a>         <strong>if</strong> (dm == <strong>null</strong> &amp;&amp; classes.contains(type)) {
<a name="287" href="#287">287</a>             <em class="comment">// make a Simple DM, this assumes the necessary tables already exist</em>
<a name="288" href="#288">288</a>             dm = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>(type);
<a name="289" href="#289">289</a>             dataMappers.put(type, dm); <em class="comment">// place it in the map</em>
<a name="290" href="#290">290</a>         }
<a name="291" href="#291">291</a>         <strong>if</strong> (dm == <strong>null</strong>) {
<a name="292" href="#292">292</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type is not a persistent class type: "</span> + type);
<a name="293" href="#293">293</a>         }
<a name="294" href="#294">294</a>         <strong>return</strong> dm;
<a name="295" href="#295">295</a>     }
<a name="296" href="#296">296</a> 
<a name="297" href="#297">297</a>     <em class="comment">// names mapping cache</em>
<a name="298" href="#298">298</a>     <strong>private</strong> Map&lt;Class&lt;?>, NamesRecord> namesRecordsCache = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, NamesRecord>();
<a name="299" href="#299">299</a>     <em>/**<em>*</em></em>
<a name="300" href="#300">300</a> <em>     * Get a names mapping for a specific class type,</em>
<a name="301" href="#301">301</a> <em>     * uses caching, will always return a mapping</em>
<a name="302" href="#302">302</a> <em>     */</em>
<a name="303" href="#303">303</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> getNamesRecord(Class&lt;?> type) {
<a name="304" href="#304">304</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> nr = namesRecordsCache.get(type);
<a name="305" href="#305">305</a>         <strong>if</strong> (nr == <strong>null</strong>) {
<a name="306" href="#306">306</a>             <em class="comment">// get a names record from the data mapper</em>
<a name="307" href="#307">307</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="308" href="#308">308</a>             nr = dm.getPropertyToColumnNamesMapping();
<a name="309" href="#309">309</a>             <strong>if</strong> (nr != <strong>null</strong>) {
<a name="310" href="#310">310</a>                 nr.setIdentifierProperty( findIdProperty(type) );
<a name="311" href="#311">311</a>                 <strong>if</strong> (nr.getForeignKeyPropertyNames().isEmpty()) {
<a name="312" href="#312">312</a>                     <em class="comment">// check for foreign keys and add them (only complete fields though)</em>
<a name="313" href="#313">313</a>                     Map&lt;String, Class&lt;?>> types = ReflectUtils.getInstance().getFieldTypes(type, FieldsFilter.COMPLETE);
<a name="314" href="#314">314</a>                     <strong>for</strong> (Entry&lt;String, Class&lt;?>> entry : types.entrySet()) {
<a name="315" href="#315">315</a>                         <em class="comment">// special handling for foreign keys identified by persistent types inside this object</em>
<a name="316" href="#316">316</a>                         String property = entry.getKey();
<a name="317" href="#317">317</a>                         Class&lt;?> pType = entry.getValue();
<a name="318" href="#318">318</a>                         <strong>if</strong> (getPersistentClasses().contains(pType)) {
<a name="319" href="#319">319</a>                             <em class="comment">// this is another persistent object so this must be a foreign key</em>
<a name="320" href="#320">320</a>                             String pId = findIdProperty(pType);
<a name="321" href="#321">321</a>                             String fkProp = property + <span class="string">"."</span> + pId;
<a name="322" href="#322">322</a>                             String column = nr.getColumnForProperty(property);
<a name="323" href="#323">323</a>                             <strong>if</strong> (column != <strong>null</strong>) {
<a name="324" href="#324">324</a>                                 nr.setForeignKeyMapping(fkProp, column);
<a name="325" href="#325">325</a>                             }
<a name="326" href="#326">326</a>                         }
<a name="327" href="#327">327</a>                     }
<a name="328" href="#328">328</a>                 }
<a name="329" href="#329">329</a>                 namesRecordsCache.put(type, nr);
<a name="330" href="#330">330</a>             }
<a name="331" href="#331">331</a>         }
<a name="332" href="#332">332</a>         <strong>if</strong> (nr == <strong>null</strong>) {
<a name="333" href="#333">333</a>             <strong>boolean</strong> usePropertyNamesForColumns = false;
<a name="334" href="#334">334</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="335" href="#335">335</a> 
<a name="336" href="#336">336</a>             ReflectUtils reflectUtils = ReflectUtils.getInstance();
<a name="337" href="#337">337</a>             <em class="comment">// try to get the mapping from the class using annotations</em>
<a name="338" href="#338">338</a>             ClassFields&lt;?> classFields = reflectUtils.analyzeClass(type);
<a name="339" href="#339">339</a>             <strong>if</strong> (<strong>class</strong>Fields.getClassAnnotations().contains(PersistentColumnMappingPolicy.<strong>class</strong>)) {
<a name="340" href="#340">340</a>                 <strong>for</strong> (Annotation classAnnote : classFields.getClassAnnotations()) {
<a name="341" href="#341">341</a>                     <strong>if</strong> (PersistentColumnMappingPolicy.<strong>class</strong>.equals(<strong>class</strong>Annote.annotationType())) {
<a name="342" href="#342">342</a>                         <a href="../../../../org/sakaiproject/genericdao/api/annotations/enums/MappingPolicy.html">MappingPolicy</a> mp = ((PersistentColumnMappingPolicy)classAnnote).policy();
<a name="343" href="#343">343</a>                         <strong>if</strong> (MappingPolicy.FIELD_NAMES.equals(mp)) {
<a name="344" href="#344">344</a>                             usePropertyNamesForColumns = <strong>true</strong>;
<a name="345" href="#345">345</a>                         } <strong>else</strong> <strong>if</strong> (MappingPolicy.UPPER_UNDERSCORES.equals(mp)) {
<a name="346" href="#346">346</a>                             usePropertyNamesForColumns = false;
<a name="347" href="#347">347</a>                         }
<a name="348" href="#348">348</a>                     }
<a name="349" href="#349">349</a>                     <strong>if</strong> (dm instanceof SimpleDataMapper) {
<a name="350" href="#350">350</a>                         <em class="comment">// override the setting</em>
<a name="351" href="#351">351</a>                         ((<a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>)dm).setUsePropertyNamesForColumns(usePropertyNamesForColumns);
<a name="352" href="#352">352</a>                     }
<a name="353" href="#353">353</a>                 }
<a name="354" href="#354">354</a>             } <strong>else</strong> {
<a name="355" href="#355">355</a>                 <em class="comment">// no annotation so get the setting from the data mapper</em>
<a name="356" href="#356">356</a>                 <strong>if</strong> (dm instanceof SimpleDataMapper) {
<a name="357" href="#357">357</a>                     usePropertyNamesForColumns = ((SimpleDataMapper)dm).isUsePropertyNamesForColumns();
<a name="358" href="#358">358</a>                 }
<a name="359" href="#359">359</a>             }
<a name="360" href="#360">360</a> 
<a name="361" href="#361">361</a>             <em class="comment">// create a names mapping using reflection</em>
<a name="362" href="#362">362</a>             nr = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a>();
<a name="363" href="#363">363</a>             Map&lt;String, Class&lt;?>> types = reflectUtils.getFieldTypes(type, FieldsFilter.COMPLETE);
<a name="364" href="#364">364</a>             <strong>for</strong> (String property : types.keySet()) {
<a name="365" href="#365">365</a>                 String column = property;
<a name="366" href="#366">366</a>                 <em class="comment">// check for transient annotation</em>
<a name="367" href="#367">367</a>                 <strong>try</strong> {
<a name="368" href="#368">368</a>                     Annotation annotation = <strong>class</strong>Fields.getFieldAnnotation(PersistentTransient.<strong>class</strong>, property);
<a name="369" href="#369">369</a>                     <strong>if</strong> (annotation != <strong>null</strong>) {
<a name="370" href="#370">370</a>                         <em class="comment">// skip this one</em>
<a name="371" href="#371">371</a>                         <strong>continue</strong>;
<a name="372" href="#372">372</a>                     }
<a name="373" href="#373">373</a>                 } <strong>catch</strong> (FieldnameNotFoundException e) {
<a name="374" href="#374">374</a>                     <em class="comment">// nothing to do</em>
<a name="375" href="#375">375</a>                 }
<a name="376" href="#376">376</a>                 <strong>if</strong> (! usePropertyNamesForColumns) {
<a name="377" href="#377">377</a>                     column = BasicTranslator.makeDBNameFromCamelCase(property);
<a name="378" href="#378">378</a>                 }
<a name="379" href="#379">379</a>                 <em class="comment">// check for annotation override to column name</em>
<a name="380" href="#380">380</a>                 <strong>try</strong> {
<a name="381" href="#381">381</a>                     <a href="../../../../org/sakaiproject/genericdao/api/annotations/PersistentColumnName.html">PersistentColumnName</a> annotation = (PersistentColumnName) <strong>class</strong>Fields.getFieldAnnotation(PersistentColumnName.<strong>class</strong>, property);
<a name="382" href="#382">382</a>                     <strong>if</strong> (annotation != <strong>null</strong>) {
<a name="383" href="#383">383</a>                         column = annotation.value();
<a name="384" href="#384">384</a>                     }
<a name="385" href="#385">385</a>                 } <strong>catch</strong> (FieldnameNotFoundException e) {
<a name="386" href="#386">386</a>                     <em class="comment">// nothing to do</em>
<a name="387" href="#387">387</a>                 }
<a name="388" href="#388">388</a>                 nr.setNameMapping(property, column);
<a name="389" href="#389">389</a>                 <em class="comment">// special handling for foreign keys identified by persistent types inside this object</em>
<a name="390" href="#390">390</a>                 Class&lt;?> pType = types.get(property);
<a name="391" href="#391">391</a>                 <strong>if</strong> (getPersistentClasses().contains(pType)) {
<a name="392" href="#392">392</a>                     <em class="comment">// this is another persistent object so this must be a foreign key</em>
<a name="393" href="#393">393</a>                     String pId = findIdProperty(pType);
<a name="394" href="#394">394</a>                     String fkProp = property + <span class="string">"."</span> + pId;
<a name="395" href="#395">395</a>                     nr.setForeignKeyMapping(fkProp, column);
<a name="396" href="#396">396</a>                 }
<a name="397" href="#397">397</a>             }
<a name="398" href="#398">398</a>             <em class="comment">// add in the special id marker and make sure the id is set right</em>
<a name="399" href="#399">399</a>             nr.setIdentifierProperty( findIdProperty(type) );
<a name="400" href="#400">400</a>             namesRecordsCache.put(type, nr);
<a name="401" href="#401">401</a>             <strong>if</strong> (dm instanceof SimpleDataMapper) {
<a name="402" href="#402">402</a>                 <em class="comment">// put this NamesRecord back into the DataMapper</em>
<a name="403" href="#403">403</a>                 ((<a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a>)dm).setNamesRecord(nr);
<a name="404" href="#404">404</a>             }
<a name="405" href="#405">405</a>         }
<a name="406" href="#406">406</a>         <strong>return</strong> nr;
<a name="407" href="#407">407</a>     }
<a name="408" href="#408">408</a> 
<a name="409" href="#409">409</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/genericdao/api/translators/DatabaseTranslator.html">DatabaseTranslator</a> databaseTranslator = <strong>null</strong>;
<a name="410" href="#410">410</a>     <em>/**<em>*</em></em>
<a name="411" href="#411">411</a> <em>     * Force the current database translator to be this one</em>
<a name="412" href="#412">412</a> <em>     */</em>
<a name="413" href="#413">413</a>     <strong>public</strong> <strong>void</strong> setDatabaseTranslator(<a href="../../../../org/sakaiproject/genericdao/api/translators/DatabaseTranslator.html">DatabaseTranslator</a> databaseTranslator) {
<a name="414" href="#414">414</a>         <strong>if</strong> (databaseTranslator != <strong>null</strong>) {
<a name="415" href="#415">415</a>             <strong>this</strong>.databaseTranslator = databaseTranslator;
<a name="416" href="#416">416</a>         }
<a name="417" href="#417">417</a>     }
<a name="418" href="#418">418</a>     <strong>protected</strong> <a href="../../../../org/sakaiproject/genericdao/api/translators/DatabaseTranslator.html">DatabaseTranslator</a> getDatabaseTranslator() {
<a name="419" href="#419">419</a>         <strong>if</strong> (<strong>this</strong>.databaseTranslator == <strong>null</strong>) {
<a name="420" href="#420">420</a>             databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/HSQLDBTranslator.html">HSQLDBTranslator</a>();
<a name="421" href="#421">421</a>         }
<a name="422" href="#422">422</a>         <strong>return</strong> <strong>this</strong>.databaseTranslator;
<a name="423" href="#423">423</a>     }
<a name="424" href="#424">424</a> 
<a name="425" href="#425">425</a>     <em>/**<em>*</em></em>
<a name="426" href="#426">426</a> <em>     * Initialize the database translator</em>
<a name="427" href="#427">427</a> <em>     */</em>
<a name="428" href="#428">428</a>     <strong>protected</strong> <strong>void</strong> initDatabaseTranslator() {
<a name="429" href="#429">429</a>         String type = getDatabaseType();
<a name="430" href="#430">430</a>         <strong>if</strong> (<strong>this</strong>.databaseTranslator == <strong>null</strong>) {
<a name="431" href="#431">431</a>             <strong>if</strong> (DatabaseTranslator.DBTYPE_DB2.equalsIgnoreCase(type)) {
<a name="432" href="#432">432</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> DB2Translator();
<a name="433" href="#433">433</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_DERBY.equalsIgnoreCase(type)) {
<a name="434" href="#434">434</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/DerbyTranslator.html">DerbyTranslator</a>();
<a name="435" href="#435">435</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_HSQLDB.equalsIgnoreCase(type)) {
<a name="436" href="#436">436</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/HSQLDBTranslator.html">HSQLDBTranslator</a>();
<a name="437" href="#437">437</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_MSSQL.equalsIgnoreCase(type)) {
<a name="438" href="#438">438</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/MSSQLTranslator.html">MSSQLTranslator</a>();
<a name="439" href="#439">439</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_MYSQL.equalsIgnoreCase(type)) {
<a name="440" href="#440">440</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/MySQLTranslator.html">MySQLTranslator</a>();
<a name="441" href="#441">441</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_ORACLE.equalsIgnoreCase(type)) {
<a name="442" href="#442">442</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/OracleTranslator.html">OracleTranslator</a>();
<a name="443" href="#443">443</a>             } <strong>else</strong> <strong>if</strong> (DatabaseTranslator.DBTYPE_POSTGRES.equalsIgnoreCase(type)) {
<a name="444" href="#444">444</a>                 <strong>this</strong>.databaseTranslator = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/translators/PostgresTranslator.html">PostgresTranslator</a>();
<a name="445" href="#445">445</a>             } <strong>else</strong> {
<a name="446" href="#446">446</a>                 <strong>throw</strong> <strong>new</strong> UnsupportedOperationException(<span class="string">"No translator for this database type: "</span> + type);
<a name="447" href="#447">447</a>             }
<a name="448" href="#448">448</a>         }
<a name="449" href="#449">449</a>     }
<a name="450" href="#450">450</a> 
<a name="451" href="#451">451</a>     <em>/**<em>*</em></em>
<a name="452" href="#452">452</a> <em>     * Initialize the persistent classes</em>
<a name="453" href="#453">453</a> <em>     */</em>
<a name="454" href="#454">454</a>     <strong>protected</strong> <strong>void</strong> initPersistentClasses() {
<a name="455" href="#455">455</a>         <em class="comment">// init the list of classes and mappers related to them and execute DDL if needed</em>
<a name="456" href="#456">456</a>         <strong>for</strong> (Class&lt;?> type : getPersistentClasses()) {
<a name="457" href="#457">457</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="458" href="#458">458</a>             <strong>if</strong> (autoDDL) {
<a name="459" href="#459">459</a>                 InputStream ddlIS = <strong>null</strong>;
<a name="460" href="#460">460</a>                 <em class="comment">// try to get DDL from the mapper first</em>
<a name="461" href="#461">461</a>                 String ddl = dm.generateDDL(getDatabaseType());
<a name="462" href="#462">462</a>                 <strong>if</strong> ( ddl == <strong>null</strong> || <span class="string">""</span>.equals(ddl) ) {
<a name="463" href="#463">463</a>                     <strong>if</strong> (dm instanceof SimpleDataMapper) {
<a name="464" href="#464">464</a>                         <em class="comment">// try loading from a file if set</em>
<a name="465" href="#465">465</a>                         <a href="../../../../org/sakaiproject/genericdao/springjdbc/SimpleDataMapper.html">SimpleDataMapper</a> sdm = (SimpleDataMapper) dm;
<a name="466" href="#466">466</a>                         String filepath = sdm.getDbTypeToFilename().get(getDatabaseType());
<a name="467" href="#467">467</a>                         <strong>if</strong> (filepath != <strong>null</strong>) {
<a name="468" href="#468">468</a>                             <em class="comment">// cleanup filename</em>
<a name="469" href="#469">469</a>                             <strong>if</strong> (filepath.startsWith(<span class="string">"/"</span>)) {
<a name="470" href="#470">470</a>                                 filepath = filepath.substring(1);
<a name="471" href="#471">471</a>                             }
<a name="472" href="#472">472</a>                             <em class="comment">// try looking in the classloader of the thread first</em>
<a name="473" href="#473">473</a>                             ddlIS = getInputStreamFromClassloader(Thread.currentThread().getContextClassLoader(), filepath);
<a name="474" href="#474">474</a>                             <strong>if</strong> (ddlIS == <strong>null</strong>) {
<a name="475" href="#475">475</a>                                 <em class="comment">// next try the classloader for this DAO</em>
<a name="476" href="#476">476</a>                                 ddlIS = getInputStreamFromClassloader(<strong>this</strong>.getClass().getClassLoader(), filepath);
<a name="477" href="#477">477</a>                             }
<a name="478" href="#478">478</a>                             <strong>if</strong> (ddlIS == <strong>null</strong>) {
<a name="479" href="#479">479</a>                                 <em class="comment">// next try the classloader for persistent type</em>
<a name="480" href="#480">480</a>                                 ddlIS = getInputStreamFromClassloader(type.getClassLoader(), filepath);
<a name="481" href="#481">481</a>                             }
<a name="482" href="#482">482</a>                             <strong>if</strong> (ddlIS == <strong>null</strong>) {
<a name="483" href="#483">483</a>                                 <em class="comment">// we got a filename but did not find the file contents, we need to die</em>
<a name="484" href="#484">484</a>                                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not find find DDL file resource ("</span>+filepath+<span class="string">") for DB ("</span>+getDatabaseType()+<span class="string">") in any searched classloader, cannot execute DDL"</span>);
<a name="485" href="#485">485</a>                             }
<a name="486" href="#486">486</a>                         }
<a name="487" href="#487">487</a>                     } <strong>else</strong> {
<a name="488" href="#488">488</a>                         <em class="comment">// nothing to do here: we have a blank ddl and this is not a simple mapper so just continue on -AZ</em>
<a name="489" href="#489">489</a>                     }
<a name="490" href="#490">490</a>                 } <strong>else</strong> {
<a name="491" href="#491">491</a>                     <em class="comment">// turn DDL into an IS</em>
<a name="492" href="#492">492</a>                     ddlIS = <strong>new</strong> ByteArrayInputStream(ddl.getBytes());
<a name="493" href="#493">493</a>                 }
<a name="494" href="#494">494</a>                 <strong>if</strong> (ddlIS != <strong>null</strong>) {
<a name="495" href="#495">495</a>                     <em class="comment">// execute the ddl</em>
<a name="496" href="#496">496</a>                     executeDDLforType(ddlIS, type);
<a name="497" href="#497">497</a>                 }
<a name="498" href="#498">498</a>             }
<a name="499" href="#499">499</a>         }
<a name="500" href="#500">500</a>     }
<a name="501" href="#501">501</a> 
<a name="502" href="#502">502</a>     <em>/**<em>*</em></em>
<a name="503" href="#503">503</a> <em>     * Get the input stream from this classloader</em>
<a name="504" href="#504">504</a> <em>     */</em>
<a name="505" href="#505">505</a>     <strong>private</strong> InputStream getInputStreamFromClassloader(ClassLoader cl, String filename) {
<a name="506" href="#506">506</a>         InputStream ddlIS = <strong>null</strong>;
<a name="507" href="#507">507</a>         <strong>if</strong> (cl != <strong>null</strong>) {
<a name="508" href="#508">508</a>             ddlIS = cl.getResourceAsStream(filename);
<a name="509" href="#509">509</a>         }
<a name="510" href="#510">510</a>         <strong>return</strong> ddlIS;
<a name="511" href="#511">511</a>     }
<a name="512" href="#512">512</a> 
<a name="513" href="#513">513</a>     <em>/**<em>*</em></em>
<a name="514" href="#514">514</a> <em>     * Starts the DAO using the settings that have been pushed into it so far &lt;br/></em>
<a name="515" href="#515">515</a> <em>     * There is no need to trigger this if it is being controlled by spring as spring</em>
<a name="516" href="#516">516</a> <em>     * will call {@link #initDao()} automatically which calls this method</em>
<a name="517" href="#517">517</a> <em>     * @throws RuntimeException if the dao fails to start</em>
<a name="518" href="#518">518</a> <em>     */</em>
<a name="519" href="#519">519</a>     <strong>public</strong> <strong>void</strong> startup() {
<a name="520" href="#520">520</a>         <strong>try</strong> {
<a name="521" href="#521">521</a>             initDao();
<a name="522" href="#522">522</a>         } <strong>catch</strong> (Exception e) {
<a name="523" href="#523">523</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failed to startup the dao: "</span> + e.getMessage(), e);
<a name="524" href="#524">524</a>         }
<a name="525" href="#525">525</a>     }
<a name="526" href="#526">526</a> 
<a name="527" href="#527">527</a>     <em>/**<em>*</em></em>
<a name="528" href="#528">528</a> <em>     * Default constructor - does nothing and leaves the object in an incomplete state,</em>
<a name="529" href="#529">529</a> <em>     * you need to at least set the following:</em>
<a name="530" href="#530">530</a> <em>     * {@link #setDataSource(DataSource)} &lt;br/></em>
<a name="531" href="#531">531</a> <em>     * {@link #setAutoDDL(boolean)} &lt;br/></em>
<a name="532" href="#532">532</a> <em>     * {@link #setAutoCommitDDL(boolean)} &lt;br/></em>
<a name="533" href="#533">533</a> <em>     * {@link #setDatabaseType(String)} &lt;br/></em>
<a name="534" href="#534">534</a> <em>     * {@link #setDataMappers(List)} &lt;br/></em>
<a name="535" href="#535">535</a> <em>     * &lt;br/></em>
<a name="536" href="#536">536</a> <em>     * This does not actually start the DAO, run {@link #startup()} to start it &lt;br/></em>
<a name="537" href="#537">537</a> <em>     * Note that this will be started automatically by Spring if this is created as a Spring bean,</em>
<a name="538" href="#538">538</a> <em>     * no actions are necessary and setting an init method is not needed</em>
<a name="539" href="#539">539</a> <em>     */</em>
<a name="540" href="#540">540</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html">JdbcGenericDao</a>() {
<a name="541" href="#541">541</a>     }
<a name="542" href="#542">542</a> 
<a name="543" href="#543">543</a>     <em>/**<em>*</em></em>
<a name="544" href="#544">544</a> <em>     * Complete constructor, sets all required values for running the DAO,</em>
<a name="545" href="#545">545</a> <em>     * does not actually start the DAO, run {@link #startup()} to start it &lt;br/></em>
<a name="546" href="#546">546</a> <em>     * Note that this will be started automatically by Spring if this is created as a Spring bean,</em>
<a name="547" href="#547">547</a> <em>     * no actions are necessary and setting an init method is not needed</em>
<a name="548" href="#548">548</a> <em>     * </em>
<a name="549" href="#549">549</a> <em>     * @param dataSource the DataSource to use with this DAO</em>
<a name="550" href="#550">550</a> <em>     * @param threadBoundDataSource if true then the DataSource will be bound to threads and </em>
<a name="551" href="#551">551</a> <em>     * only unbound and closed when {@link #closeConnection()} is called,</em>
<a name="552" href="#552">552</a> <em>     * otherwise a new DataSource is obtained each time, </em>
<a name="553" href="#553">553</a> <em>     * this has no effect if the DataSource is a Spring DataSource</em>
<a name="554" href="#554">554</a> <em>     * @param databaseType the databaseType that this DAO is connecting to (use constants in {@link DatabaseTranslator})</em>
<a name="555" href="#555">555</a> <em>     * @param autoDDL if true then DDL is executed on DAO startup (can be run manually if desired)</em>
<a name="556" href="#556">556</a> <em>     * @param autoCommitDDL if true then commit is executed after each DDL file is executed, if false then you need a TX manager to do this for you</em>
<a name="557" href="#557">557</a> <em>     * @param dataMappers the data mappers which map this DAO to the tables</em>
<a name="558" href="#558">558</a> <em>     */</em>
<a name="559" href="#559">559</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/genericdao/springjdbc/JdbcGenericDao.html">JdbcGenericDao</a>(DataSource dataSource, <strong>boolean</strong> threadBoundDataSource, 
<a name="560" href="#560">560</a>             String databaseType, <strong>boolean</strong> autoDDL, <strong>boolean</strong> autoCommitDDL, <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a>[] dataMappers) {
<a name="561" href="#561">561</a>         setRequiredSettings(dataSource, threadBoundDataSource, databaseType, autoDDL, autoCommitDDL, dataMappers);
<a name="562" href="#562">562</a>     }
<a name="563" href="#563">563</a> 
<a name="564" href="#564">564</a>     <em>/**<em>*</em></em>
<a name="565" href="#565">565</a> <em>     * Set all required settings for running the DAO,</em>
<a name="566" href="#566">566</a> <em>     * can be used in the cases where using the complete constructor is inconvenient &lt;br/></em>
<a name="567" href="#567">567</a> <em>     * This does not actually start the DAO, run {@link #startup()} to start it &lt;br/></em>
<a name="568" href="#568">568</a> <em>     * Note that this will be started automatically by Spring if this is created as a Spring bean,</em>
<a name="569" href="#569">569</a> <em>     * no actions are necessary and setting an init method is not needed</em>
<a name="570" href="#570">570</a> <em>     * </em>
<a name="571" href="#571">571</a> <em>     * @param dataSource the DataSource to use with this DAO</em>
<a name="572" href="#572">572</a> <em>     * @param threadBoundDataSource if true then the DataSource will be bound to threads and </em>
<a name="573" href="#573">573</a> <em>     * only unbound and closed when {@link #closeConnection()} is called,</em>
<a name="574" href="#574">574</a> <em>     * otherwise a new DataSource is obtained each time, </em>
<a name="575" href="#575">575</a> <em>     * this has no effect if the DataSource is a Spring DataSource</em>
<a name="576" href="#576">576</a> <em>     * @param databaseType the databaseType that this DAO is connecting to (use constants in {@link DatabaseTranslator})</em>
<a name="577" href="#577">577</a> <em>     * @param autoDDL if true then DDL is executed on DAO startup (can be run manually if desired)</em>
<a name="578" href="#578">578</a> <em>     * @param autoCommitDDL if true then commit is executed after each DDL file is executed, if false then you need a TX manager to do this for you</em>
<a name="579" href="#579">579</a> <em>     * @param dataMappers the data mappers which map this DAO to the tables</em>
<a name="580" href="#580">580</a> <em>     */</em>
<a name="581" href="#581">581</a>     <strong>public</strong> <strong>void</strong> setRequiredSettings(DataSource dataSource, <strong>boolean</strong> threadBoundDataSource, 
<a name="582" href="#582">582</a>             String databaseType, <strong>boolean</strong> autoDDL, <strong>boolean</strong> autoCommitDDL, <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a>[] dataMappers) {
<a name="583" href="#583">583</a>         <strong>if</strong> (dataSource != <strong>null</strong>) {
<a name="584" href="#584">584</a>             <em class="comment">// correctly sets the datasource if non-spring or spring</em>
<a name="585" href="#585">585</a>             setNonSpringDataSource(dataSource, threadBoundDataSource);
<a name="586" href="#586">586</a>         }
<a name="587" href="#587">587</a>         setDatabaseType(databaseType);
<a name="588" href="#588">588</a>         <strong>if</strong> (dataMappers == <strong>null</strong> || dataMappers.length == 0) {
<a name="589" href="#589">589</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"DataMappers must be set and must be greater than one"</span>);
<a name="590" href="#590">590</a>         }
<a name="591" href="#591">591</a>         ArrayList&lt;DataMapper> mappers = <strong>new</strong> ArrayList&lt;DataMapper>();
<a name="592" href="#592">592</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; dataMappers.length; i++) {
<a name="593" href="#593">593</a>             mappers.add(dataMappers[i]);
<a name="594" href="#594">594</a>         }
<a name="595" href="#595">595</a>         setDataMappers(mappers);
<a name="596" href="#596">596</a>         setAutoDDL(autoDDL);
<a name="597" href="#597">597</a>         setAutoCommitDDL(autoCommitDDL);
<a name="598" href="#598">598</a>     }
<a name="599" href="#599">599</a> 
<a name="600" href="#600">600</a>     @Override
<a name="601" href="#601">601</a>     <strong>protected</strong> <strong>void</strong> initDao() throws Exception {
<a name="602" href="#602">602</a>         <strong>super</strong>.initDao();
<a name="603" href="#603">603</a>         <em class="comment">// now we run our own inits</em>
<a name="604" href="#604">604</a>         <em class="comment">// init the database translator based on the type</em>
<a name="605" href="#605">605</a>         initDatabaseTranslator();
<a name="606" href="#606">606</a>         <em class="comment">// init the list of classes and mappers related to them and execute DDL if needed</em>
<a name="607" href="#607">607</a>         initPersistentClasses();
<a name="608" href="#608">608</a>         <em class="comment">// init the caches</em>
<a name="609" href="#609">609</a>         initCaches();
<a name="610" href="#610">610</a>     }
<a name="611" href="#611">611</a> 
<a name="612" href="#612">612</a>     <em>/**<em>*</em></em>
<a name="613" href="#613">613</a> <em>     * Find the tablename from the classname</em>
<a name="614" href="#614">614</a> <em>     */</em>
<a name="615" href="#615">615</a>     <strong>protected</strong> String getTableNameFromClass(Class&lt;?> type) {
<a name="616" href="#616">616</a>         String tableName = getDataMapper(type).getTableName();
<a name="617" href="#617">617</a>         <strong>if</strong> (<span class="string">""</span>.equals(tableName) || tableName == <strong>null</strong>) {
<a name="618" href="#618">618</a>             <em class="comment">// generate the table name based on defaults</em>
<a name="619" href="#619">619</a>             tableName = BasicTranslator.makeTableNameFromClass(type);
<a name="620" href="#620">620</a>         }
<a name="621" href="#621">621</a>         <strong>return</strong> tableName;
<a name="622" href="#622">622</a>     }
<a name="623" href="#623">623</a> 
<a name="624" href="#624">624</a>     <em>/**<em>*</em></em>
<a name="625" href="#625">625</a> <em>     * Make an entity of type T from a map of DB data</em>
<a name="626" href="#626">626</a> <em>     * @param &lt;T></em>
<a name="627" href="#627">627</a> <em>     * @param type a persistent entity type</em>
<a name="628" href="#628">628</a> <em>     * @param data a map of column names to data values</em>
<a name="629" href="#629">629</a> <em>     * @return an entity of type T with the data from the map in the entity</em>
<a name="630" href="#630">630</a> <em>     */</em>
<a name="631" href="#631">631</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="632" href="#632">632</a>     <strong>protected</strong> &lt;T> T makeEntityFromMap(Class&lt;T> type, Map&lt;String, Object> data) {
<a name="633" href="#633">633</a>         <strong>if</strong> (type == <strong>null</strong> || data == <strong>null</strong>) {
<a name="634" href="#634">634</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"type and data cannot be null"</span>);
<a name="635" href="#635">635</a>         }
<a name="636" href="#636">636</a>         T entity = <strong>null</strong>;
<a name="637" href="#637">637</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="638" href="#638">638</a>         <strong>if</strong> (dm != <strong>null</strong> &amp;&amp; dm instanceof EntityColumnMapper) {
<a name="639" href="#639">639</a>             entity = (T) ((EntityColumnMapper)dm).mapColumnsToObject(data);
<a name="640" href="#640">640</a>         }
<a name="641" href="#641">641</a>         <strong>if</strong> (entity == <strong>null</strong>) {
<a name="642" href="#642">642</a>             <em class="comment">// use reflection to construct and push the values into the object</em>
<a name="643" href="#643">643</a>             Map&lt;String, Class&lt;?>> types = ReflectUtils.getInstance().getFieldTypes(type, FieldsFilter.WRITEABLE);
<a name="644" href="#644">644</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> nr = getNamesRecord(type);
<a name="645" href="#645">645</a>             entity = ReflectUtils.getInstance().constructClass(type);
<a name="646" href="#646">646</a>             <strong>for</strong> (Entry&lt;String, Object> entry : data.entrySet()) {
<a name="647" href="#647">647</a>                 String key = entry.getKey();
<a name="648" href="#648">648</a>                 String property = nr.getPropertyForColumn(key);
<a name="649" href="#649">649</a>                 <strong>if</strong> (property != <strong>null</strong>) {
<a name="650" href="#650">650</a>                     Object value = entry.getValue();
<a name="651" href="#651">651</a>                     <em class="comment">// special handling for persistent types inside this type</em>
<a name="652" href="#652">652</a>                     Class&lt;?> pType = <strong>null</strong>;
<a name="653" href="#653">653</a>                     <strong>if</strong> (types.containsKey(property)) {
<a name="654" href="#654">654</a>                         pType = types.get(property);
<a name="655" href="#655">655</a>                         <strong>if</strong> (! getPersistentClasses().contains(pType)) {
<a name="656" href="#656">656</a>                             pType = <strong>null</strong>;
<a name="657" href="#657">657</a>                         }
<a name="658" href="#658">658</a>                     }
<a name="659" href="#659">659</a>                     <strong>if</strong> (pType != <strong>null</strong>) {
<a name="660" href="#660">660</a>                         <em class="comment">// this is another persistent object so this must be a foreign key</em>
<a name="661" href="#661">661</a>                         String pId = getIdProperty(pType);
<a name="662" href="#662">662</a>                         <em class="comment">// TODO use the old way once reflect utils can build the path automatically</em>
<a name="663" href="#663">663</a>                         <em class="comment">//                property = property + "." + pId;</em>
<a name="664" href="#664">664</a>                         <em class="comment">//                if (value != null </em>
<a name="665" href="#665">665</a>                         <em class="comment">//                &amp;&amp; value.getClass().isAssignableFrom(pType)) {</em>
<a name="666" href="#666">666</a>                         <em class="comment">//                value = ReflectUtil.getInstance().getFieldValue(value, pId);</em>
<a name="667" href="#667">667</a>                         <em class="comment">//                }</em>
<a name="668" href="#668">668</a>                         <em class="comment">// this will create the object for us for now</em>
<a name="669" href="#669">669</a>                         Object pValue = value;
<a name="670" href="#670">670</a>                         <strong>if</strong> (value != <strong>null</strong> 
<a name="671" href="#671">671</a>                                 &amp;&amp; value.getClass().isAssignableFrom(pType)) {
<a name="672" href="#672">672</a>                             pValue = ReflectUtils.getInstance().getFieldValue(value, pId);
<a name="673" href="#673">673</a>                         }
<a name="674" href="#674">674</a>                         value = ReflectUtils.getInstance().constructClass(pType);
<a name="675" href="#675">675</a>                         ReflectUtils.getInstance().setFieldValue(value, pId, pValue);
<a name="676" href="#676">676</a>                     }
<a name="677" href="#677">677</a>                     ReflectUtils.getInstance().setFieldValue(entity, property, value);
<a name="678" href="#678">678</a>                 }
<a name="679" href="#679">679</a>             }            
<a name="680" href="#680">680</a>         }
<a name="681" href="#681">681</a>         <strong>return</strong> entity;
<a name="682" href="#682">682</a>     }
<a name="683" href="#683">683</a> 
<a name="684" href="#684">684</a>     <em>/**<em>*</em></em>
<a name="685" href="#685">685</a> <em>     * Make a map of column names -> column values from an entity</em>
<a name="686" href="#686">686</a> <em>     * @param entity</em>
<a name="687" href="#687">687</a> <em>     * @return a map of the data in a persistent entity which has the column names as keys</em>
<a name="688" href="#688">688</a> <em>     */</em>
<a name="689" href="#689">689</a>     <strong>protected</strong> Map&lt;String, Object> makeMapFromEntity(Object entity) {
<a name="690" href="#690">690</a>         <strong>if</strong> (entity == <strong>null</strong>) {
<a name="691" href="#691">691</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"entity cannot be null"</span>);
<a name="692" href="#692">692</a>         }
<a name="693" href="#693">693</a>         Class&lt;?> type = entity.getClass();
<a name="694" href="#694">694</a>         Map&lt;String, Object> data = <strong>null</strong>;
<a name="695" href="#695">695</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="696" href="#696">696</a>         <strong>if</strong> (dm != <strong>null</strong> &amp;&amp; dm instanceof EntityColumnMapper) {
<a name="697" href="#697">697</a>             data = ((EntityColumnMapper)dm).mapObjectToColumns(entity);
<a name="698" href="#698">698</a>         }
<a name="699" href="#699">699</a>         <strong>if</strong> (data == <strong>null</strong> || data.isEmpty()) {
<a name="700" href="#700">700</a>             <strong>if</strong> (data == <strong>null</strong>) {
<a name="701" href="#701">701</a>                 data = <strong>new</strong> HashMap&lt;String, Object>();
<a name="702" href="#702">702</a>             }
<a name="703" href="#703">703</a>             <em class="comment">// get data from object using reflection</em>
<a name="704" href="#704">704</a>             Map&lt;String, Class&lt;?>> types = ReflectUtils.getInstance().getFieldTypes(type, FieldsFilter.ALL); <em class="comment">// faster</em>
<a name="705" href="#705">705</a>             Map&lt;String, Object> objectValues = ReflectUtils.getInstance().getObjectValues(entity, FieldsFilter.READABLE, false);
<a name="706" href="#706">706</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> nr = getNamesRecord(type);
<a name="707" href="#707">707</a>             <strong>for</strong> (Entry&lt;String, Object> entry : objectValues.entrySet()) {
<a name="708" href="#708">708</a>                 String property = entry.getKey();
<a name="709" href="#709">709</a>                 String dbName = nr.getColumnForProperty(property);
<a name="710" href="#710">710</a>                 <strong>if</strong> (dbName != <strong>null</strong>) {
<a name="711" href="#711">711</a>                     Object value = entry.getValue();
<a name="712" href="#712">712</a>                     <em class="comment">// special handling for persistent types inside this type</em>
<a name="713" href="#713">713</a>                     Class&lt;?> pType = <strong>null</strong>;
<a name="714" href="#714">714</a>                     <strong>if</strong> (types.containsKey(property)) {
<a name="715" href="#715">715</a>                         pType = types.get(property);
<a name="716" href="#716">716</a>                         <strong>if</strong> (! getPersistentClasses().contains(pType)) {
<a name="717" href="#717">717</a>                             pType = <strong>null</strong>;
<a name="718" href="#718">718</a>                         }
<a name="719" href="#719">719</a>                     }
<a name="720" href="#720">720</a>                     <strong>if</strong> (pType != <strong>null</strong>) {
<a name="721" href="#721">721</a>                         <em class="comment">// this is another persistent object so this must be a foreign key</em>
<a name="722" href="#722">722</a>                         String pId = getIdProperty(pType);
<a name="723" href="#723">723</a>                         value = ReflectUtils.getInstance().getFieldValue(value, pId);
<a name="724" href="#724">724</a>                     }
<a name="725" href="#725">725</a>                     data.put(dbName, value);
<a name="726" href="#726">726</a>                 }
<a name="727" href="#727">727</a>             }
<a name="728" href="#728">728</a>         }
<a name="729" href="#729">729</a>         <strong>return</strong> data;
<a name="730" href="#730">730</a>     }
<a name="731" href="#731">731</a> 
<a name="732" href="#732">732</a>     <em class="comment">// *********** Helper methods</em>
<a name="733" href="#733">733</a> 
<a name="734" href="#734">734</a>     <em>/**<em>*</em></em>
<a name="735" href="#735">735</a> <em>     * Logs a message to standard out, allows easy control over where logging is going later on</em>
<a name="736" href="#736">736</a> <em>     * </em>
<a name="737" href="#737">737</a> <em>     * @param message the message to output</em>
<a name="738" href="#738">738</a> <em>     */</em>
<a name="739" href="#739">739</a>     <strong>protected</strong> <strong>void</strong> logInfo(String message) {
<a name="740" href="#740">740</a>         System.out.println(<span class="string">"INFO: [GenericDao] "</span> + message);
<a name="741" href="#741">741</a>     }
<a name="742" href="#742">742</a> 
<a name="743" href="#743">743</a>     <em>/**<em>*</em></em>
<a name="744" href="#744">744</a> <em>     * Logs a message to standard out, allows easy control over where logging is going later on</em>
<a name="745" href="#745">745</a> <em>     * </em>
<a name="746" href="#746">746</a> <em>     * @param message the message to output</em>
<a name="747" href="#747">747</a> <em>     */</em>
<a name="748" href="#748">748</a>     <strong>protected</strong> <strong>void</strong> logWarn(String message) {
<a name="749" href="#749">749</a>         System.out.println(<span class="string">"WARN: [GenericDao] "</span> + message);
<a name="750" href="#750">750</a>     }
<a name="751" href="#751">751</a> 
<a name="752" href="#752">752</a>     <em>/**<em>*</em></em>
<a name="753" href="#753">753</a> <em>     * This will determine the id property correctly (but fairly inefficiently) so this should be cached,</em>
<a name="754" href="#754">754</a> <em>     * use {@link #getIdProperty(Class)} to get the id property for a class</em>
<a name="755" href="#755">755</a> <em>     * @param type a persistent type</em>
<a name="756" href="#756">756</a> <em>     * @return</em>
<a name="757" href="#757">757</a> <em>     */</em>
<a name="758" href="#758">758</a>     <strong>protected</strong> String findIdProperty(Class&lt;?> type) {
<a name="759" href="#759">759</a>         String idProp = <strong>null</strong>;
<a name="760" href="#760">760</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="761" href="#761">761</a>         <strong>if</strong> (dm != <strong>null</strong>) {
<a name="762" href="#762">762</a>             idProp = dm.getIdPropertyName();
<a name="763" href="#763">763</a>         }
<a name="764" href="#764">764</a>         <strong>if</strong> (classes.contains(type)) {
<a name="765" href="#765">765</a>             <strong>if</strong> (idProp == <strong>null</strong>) {
<a name="766" href="#766">766</a>                 <em class="comment">// look for the annotation</em>
<a name="767" href="#767">767</a>                 idProp = ReflectUtils.getInstance().getFieldNameWithAnnotation(type, PersistentId.<strong>class</strong>);
<a name="768" href="#768">768</a>             }
<a name="769" href="#769">769</a>             <strong>if</strong> (idProp == <strong>null</strong>) {
<a name="770" href="#770">770</a>                 idProp = <span class="string">"id"</span>;
<a name="771" href="#771">771</a>             }
<a name="772" href="#772">772</a>         }
<a name="773" href="#773">773</a>         <strong>return</strong> idProp;
<a name="774" href="#774">774</a>     }
<a name="775" href="#775">775</a> 
<a name="776" href="#776">776</a>     <em>/**<em>*</em></em>
<a name="777" href="#777">777</a> <em>     * @param type a persistent type</em>
<a name="778" href="#778">778</a> <em>     * @return the id column name</em>
<a name="779" href="#779">779</a> <em>     */</em>
<a name="780" href="#780">780</a>     <strong>public</strong> String getIdColumn(Class&lt;?> type) {
<a name="781" href="#781">781</a>         String idProp = getIdProperty(type);
<a name="782" href="#782">782</a>         String idColumn = getNamesRecord(type).getColumnForProperty(idProp);
<a name="783" href="#783">783</a>         <strong>if</strong> (idColumn == <strong>null</strong> &amp;&amp; classes.contains(type)) {
<a name="784" href="#784">784</a>             idColumn = <span class="string">"ID"</span>;
<a name="785" href="#785">785</a>         }
<a name="786" href="#786">786</a>         <strong>return</strong> idColumn;
<a name="787" href="#787">787</a>     }
<a name="788" href="#788">788</a> 
<a name="789" href="#789">789</a>     <em>/**<em>*</em></em>
<a name="790" href="#790">790</a> <em>     * @param object a persistent object</em>
<a name="791" href="#791">791</a> <em>     * @return the value in the id property for the supplied object</em>
<a name="792" href="#792">792</a> <em>     */</em>
<a name="793" href="#793">793</a>     <strong>protected</strong> Object getIdValue(Object object) {
<a name="794" href="#794">794</a>         Class&lt;?> entityClass = object.getClass();
<a name="795" href="#795">795</a>         Object id = <strong>null</strong>;
<a name="796" href="#796">796</a>         String idProp = getIdProperty(entityClass);
<a name="797" href="#797">797</a>         <strong>if</strong> (idProp != <strong>null</strong>) {
<a name="798" href="#798">798</a>             id = ReflectUtils.getInstance().getFieldValue(object, idProp);
<a name="799" href="#799">799</a>         }
<a name="800" href="#800">800</a>         <strong>return</strong> id;
<a name="801" href="#801">801</a>     }
<a name="802" href="#802">802</a> 
<a name="803" href="#803">803</a>     <em>/**<em>*</em></em>
<a name="804" href="#804">804</a> <em>     * This helper method will convert the incoming data if it needs to be</em>
<a name="805" href="#805">805</a> <em>     * converted for the given column, otherwise it will do nothing to the value</em>
<a name="806" href="#806">806</a> <em>     * @param type the persistent class type</em>
<a name="807" href="#807">807</a> <em>     * @param column the name of the column this value is associated with</em>
<a name="808" href="#808">808</a> <em>     * @param value the value to convert</em>
<a name="809" href="#809">809</a> <em>     * @return the converted value or the original value if no conversion needed</em>
<a name="810" href="#810">810</a> <em>     */</em>
<a name="811" href="#811">811</a>     <strong>protected</strong> Object convertColumn(Class&lt;?> type, String column, Object value) {
<a name="812" href="#812">812</a>         <strong>if</strong> (type != <strong>null</strong> &amp;&amp; column != <strong>null</strong>) {
<a name="813" href="#813">813</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> namesRecord = getNamesRecord(type);
<a name="814" href="#814">814</a>             value = JDBCUtils.convertColumn(namesRecord, column, value);
<a name="815" href="#815">815</a>         }
<a name="816" href="#816">816</a>         <strong>return</strong> value;
<a name="817" href="#817">817</a>     }
<a name="818" href="#818">818</a> 
<a name="819" href="#819">819</a>     <em>/**<em>*</em></em>
<a name="820" href="#820">820</a> <em>     * @return the template to use when generating insert statements,</em>
<a name="821" href="#821">821</a> <em>     * uses the {@link StatementMapper#TABLE_NAME}, {@link StatementMapper#COLUMNS} and {@link StatementMapper#VALUES} constants to indicate replacements</em>
<a name="822" href="#822">822</a> <em>     */</em>
<a name="823" href="#823">823</a>     <strong>public</strong> String getInsertTemplate(Class&lt;?> type) {
<a name="824" href="#824">824</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="825" href="#825">825</a>         String template = <strong>null</strong>;
<a name="826" href="#826">826</a>         <strong>if</strong> (dm instanceof StatementMapper) {
<a name="827" href="#827">827</a>             template = ((StatementMapper)dm).getInsertTemplate();
<a name="828" href="#828">828</a>         }
<a name="829" href="#829">829</a>         <strong>if</strong> (template == <strong>null</strong> || <span class="string">""</span>.equals(template)) {
<a name="830" href="#830">830</a>             template = StatementMapper.BASIC_INSERT;
<a name="831" href="#831">831</a>         }
<a name="832" href="#832">832</a>         <strong>return</strong> template;      
<a name="833" href="#833">833</a>     }
<a name="834" href="#834">834</a> 
<a name="835" href="#835">835</a>     <em>/**<em>*</em></em>
<a name="836" href="#836">836</a> <em>     * @return the template to use when generating selects,</em>
<a name="837" href="#837">837</a> <em>     * uses the {@link StatementMapper#SELECT}, {@link StatementMapper#TABLE_NAME}, and {@link StatementMapper#WHERE} constants to indicate replacements</em>
<a name="838" href="#838">838</a> <em>     */</em>
<a name="839" href="#839">839</a>     <strong>public</strong> String getSelectTemplate(Class&lt;?> type) {
<a name="840" href="#840">840</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="841" href="#841">841</a>         String template = <strong>null</strong>;
<a name="842" href="#842">842</a>         <strong>if</strong> (dm instanceof StatementMapper) {
<a name="843" href="#843">843</a>             template = ((StatementMapper)dm).getSelectTemplate();
<a name="844" href="#844">844</a>         }
<a name="845" href="#845">845</a>         <strong>if</strong> (template == <strong>null</strong> || <span class="string">""</span>.equals(template)) {
<a name="846" href="#846">846</a>             template = StatementMapper.BASIC_SELECT;
<a name="847" href="#847">847</a>         }
<a name="848" href="#848">848</a>         <strong>return</strong> template;      
<a name="849" href="#849">849</a>     }
<a name="850" href="#850">850</a> 
<a name="851" href="#851">851</a>     <em>/**<em>*</em></em>
<a name="852" href="#852">852</a> <em>     * @return the template to use when generating updates,</em>
<a name="853" href="#853">853</a> <em>     * uses the {@link StatementMapper#TABLE_NAME}, {@link StatementMapper#UPDATE} and {@link StatementMapper#WHERE} constants to indicate replacements</em>
<a name="854" href="#854">854</a> <em>     */</em>
<a name="855" href="#855">855</a>     <strong>public</strong> String getUpdateTemplate(Class&lt;?> type) {
<a name="856" href="#856">856</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="857" href="#857">857</a>         String template = <strong>null</strong>;
<a name="858" href="#858">858</a>         <strong>if</strong> (dm instanceof StatementMapper) {
<a name="859" href="#859">859</a>             template = ((StatementMapper)dm).getUpdateTemplate();
<a name="860" href="#860">860</a>         }
<a name="861" href="#861">861</a>         <strong>if</strong> (template == <strong>null</strong> || <span class="string">""</span>.equals(template)) {
<a name="862" href="#862">862</a>             template = StatementMapper.BASIC_UPDATE;
<a name="863" href="#863">863</a>         }
<a name="864" href="#864">864</a>         <strong>return</strong> template;      
<a name="865" href="#865">865</a>     }
<a name="866" href="#866">866</a> 
<a name="867" href="#867">867</a>     <em>/**<em>*</em></em>
<a name="868" href="#868">868</a> <em>     * @return the template to use when generating deletes,</em>
<a name="869" href="#869">869</a> <em>     * uses the {@link StatementMapper#TABLE_NAME} and {@link StatementMapper#WHERE} constants to indicate replacements</em>
<a name="870" href="#870">870</a> <em>     */</em>
<a name="871" href="#871">871</a>     <strong>public</strong> String getDeleteTemplate(Class&lt;?> type) {
<a name="872" href="#872">872</a>         <a href="../../../../org/sakaiproject/genericdao/api/mappers/DataMapper.html">DataMapper</a> dm = getDataMapper(type);
<a name="873" href="#873">873</a>         String template = <strong>null</strong>;
<a name="874" href="#874">874</a>         <strong>if</strong> (dm instanceof StatementMapper) {
<a name="875" href="#875">875</a>             template = ((StatementMapper)dm).getDeleteTemplate();
<a name="876" href="#876">876</a>         }
<a name="877" href="#877">877</a>         <strong>if</strong> (template == <strong>null</strong> || <span class="string">""</span>.equals(template)) {
<a name="878" href="#878">878</a>             template = StatementMapper.BASIC_DELETE;
<a name="879" href="#879">879</a>         }
<a name="880" href="#880">880</a>         <strong>return</strong> template;      
<a name="881" href="#881">881</a>     }
<a name="882" href="#882">882</a> 
<a name="883" href="#883">883</a> 
<a name="884" href="#884">884</a>     <em class="comment">// ********* DDL methods</em>
<a name="885" href="#885">885</a> 
<a name="886" href="#886">886</a>     <em>/**<em>*</em></em>
<a name="887" href="#887">887</a> <em>     * Clear the table associated with this DAO persistent class</em>
<a name="888" href="#888">888</a> <em>     * @param type any persistent type</em>
<a name="889" href="#889">889</a> <em>     */</em>
<a name="890" href="#890">890</a>     <strong>public</strong> <strong>void</strong> clearDataForType(Class&lt;?> type) {
<a name="891" href="#891">891</a>         String sql = <span class="string">"TRUNCATE TABLE "</span> + getTableNameFromClass(type);
<a name="892" href="#892">892</a>         <strong>try</strong> {
<a name="893" href="#893">893</a>             getSpringJdbcTemplate().execute(sql);
<a name="894" href="#894">894</a>             <strong>if</strong> (showSQL) {
<a name="895" href="#895">895</a>                 logInfo(<span class="string">"SQL="</span>+sql);
<a name="896" href="#896">896</a>             }
<a name="897" href="#897">897</a>         } <strong>catch</strong> (DataAccessException e) {
<a name="898" href="#898">898</a>             <em class="comment">// ok, try doing the clear using a delete from which is much slower</em>
<a name="899" href="#899">899</a>             sql = <span class="string">"DELETE FROM "</span> + getTableNameFromClass(type);
<a name="900" href="#900">900</a>             <strong>if</strong> (showSQL) {
<a name="901" href="#901">901</a>                 logInfo(<span class="string">"SQL="</span>+sql);
<a name="902" href="#902">902</a>             }
<a name="903" href="#903">903</a>             getSpringJdbcTemplate().execute(sql);
<a name="904" href="#904">904</a>         } <strong>finally</strong> {
<a name="905" href="#905">905</a>             commitTransaction();
<a name="906" href="#906">906</a>         }
<a name="907" href="#907">907</a>     }
<a name="908" href="#908">908</a> 
<a name="909" href="#909">909</a>     <em>/**<em>*</em></em>
<a name="910" href="#910">910</a> <em>     * Drop the table associated with this persistent type</em>
<a name="911" href="#911">911</a> <em>     * @param type any persistent type</em>
<a name="912" href="#912">912</a> <em>     */</em>
<a name="913" href="#913">913</a>     <strong>public</strong> <strong>void</strong> dropTableForType(Class&lt;?> type) {
<a name="914" href="#914">914</a>         String sql = <span class="string">"DROP TABLE "</span> + getTableNameFromClass(type);
<a name="915" href="#915">915</a>         <strong>try</strong> {
<a name="916" href="#916">916</a>             <strong>if</strong> (showSQL) {
<a name="917" href="#917">917</a>                 logInfo(<span class="string">"SQL="</span>+sql);
<a name="918" href="#918">918</a>             }
<a name="919" href="#919">919</a>             getSpringJdbcTemplate().execute(<span class="string">"DROP TABLE "</span> + getTableNameFromClass(type));
<a name="920" href="#920">920</a>             commitTransaction();
<a name="921" href="#921">921</a>         } <strong>catch</strong> (DataAccessException e) {
<a name="922" href="#922">922</a>             rollbackTransaction();
<a name="923" href="#923">923</a>             <strong>throw</strong> e;
<a name="924" href="#924">924</a>         }
<a name="925" href="#925">925</a>     }
<a name="926" href="#926">926</a> 
<a name="927" href="#927">927</a>     <em>/**<em>*</em></em>
<a name="928" href="#928">928</a> <em>     * Execute a DDL (database definition language) script, this will execute</em>
<a name="929" href="#929">929</a> <em>     * a set of DDL commands which are fed in via an InputStream&lt;br/></em>
<a name="930" href="#930">930</a> <em>     * The first non-comment ('--') line will be run, and if successful, </em>
<a name="931" href="#931">931</a> <em>     * all other non-comment lines will be run. SQL statements may be on </em>
<a name="932" href="#932">932</a> <em>     * multiple lines but must have ';' terminators.&lt;br/></em>
<a name="933" href="#933">933</a> <em>     * &lt;br/></em>
<a name="934" href="#934">934</a> <em>     * &lt;b>NOTE:&lt;/b> The script should be located in the current ClassLoader,</em>
<a name="935" href="#935">935</a> <em>     * in other words, it must be a visible resource that is packaged with</em>
<a name="936" href="#936">936</a> <em>     * the code that is running this method&lt;br/></em>
<a name="937" href="#937">937</a> <em>     * Recommended (Example) usage:&lt;br/></em>
<a name="938" href="#938">938</a> <em>     * 1) Place the script into the src folder of your service impl project like so:</em>
<a name="939" href="#939">939</a> <em>     * &lt;code>impl/src/sql/oracle/myscript.sql&lt;/code>&lt;br/></em>
<a name="940" href="#940">940</a> <em>     * 2) Load the sql files into the jar by setting up the maven pom like so:</em>
<a name="941" href="#941">941</a> <em>     * &lt;xmp></em>
<a name="942" href="#942">942</a> <em>&lt;resources></em>
<a name="943" href="#943">943</a> <em>...</em>
<a name="944" href="#944">944</a> <em>   &lt;resource></em>
<a name="945" href="#945">945</a> <em>      &lt;directory>${basedir}/src/sql&lt;/directory></em>
<a name="946" href="#946">946</a> <em>      &lt;includes></em>
<a name="947" href="#947">947</a> <em>         &lt;include>** /*.sql&lt;/include></em>
<a name="948" href="#948">948</a> <em>      &lt;/includes></em>
<a name="949" href="#949">949</a> <em>   &lt;/resource></em>
<a name="950" href="#950">950</a> <em>...</em>
<a name="951" href="#951">951</a> <em>&lt;/resources>&lt;/xmp> </em>
<a name="952" href="#952">952</a> <em>     * &lt;b>Note:&lt;/b> remove the extra space between "**" and "/*.sql"&lt;br/></em>
<a name="953" href="#953">953</a> <em>     * 3) Execute the ddl script in the init method of your DAO (when it first starts up):</em>
<a name="954" href="#954">954</a> <em>     * &lt;code>ClassLoader loader = this.getClass().getClassLoader();&lt;/code>&lt;br/></em>
<a name="955" href="#955">955</a> <em>     * &lt;code>String ddlResource = getDatabaseType() + "/myscript.sql";&lt;/code>&lt;br/></em>
<a name="956" href="#956">956</a> <em>     * &lt;code>InputStream stream = loader.getResourceAsStream(ddlResource);&lt;/code>&lt;br/></em>
<a name="957" href="#957">957</a> <em>     * &lt;code>executeDDL(stream);&lt;/code>&lt;br/></em>
<a name="958" href="#958">958</a> <em>     * </em>
<a name="959" href="#959">959</a> <em>     * @param sqlDDL the sql ddl commands to execute</em>
<a name="960" href="#960">960</a> <em>     * @throws IllegalArgumentException if ddl is invalid and cannot be executed</em>
<a name="961" href="#961">961</a> <em>     */</em>
<a name="962" href="#962">962</a>     <strong>public</strong> <strong>void</strong> executeDDL(InputStream sqlDDL) {
<a name="963" href="#963">963</a>         <strong>if</strong> (sqlDDL == <strong>null</strong>) {
<a name="964" href="#964">964</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"sqlDDL cannot be null"</span>);
<a name="965" href="#965">965</a>         }
<a name="966" href="#966">966</a> 
<a name="967" href="#967">967</a>         executeDDLforType(sqlDDL, <strong>null</strong>);
<a name="968" href="#968">968</a>     }
<a name="969" href="#969">969</a> 
<a name="970" href="#970">970</a>     <strong>private</strong> <strong>void</strong> executeDDLforType(InputStream sqlDDL, Class&lt;?> type) {
<a name="971" href="#971">971</a>         <em class="comment">// Now run the DDL commands if possible</em>
<a name="972" href="#972">972</a>         <strong>try</strong> {
<a name="973" href="#973">973</a>             <strong>if</strong> (isAutoCommitDDL()) {
<a name="974" href="#974">974</a>                 commitTransaction(); <em class="comment">// start the transaction</em>
<a name="975" href="#975">975</a>             }
<a name="976" href="#976">976</a>             BufferedReader r = <strong>new</strong> BufferedReader(<strong>new</strong> InputStreamReader(sqlDDL));
<a name="977" href="#977">977</a>             <strong>try</strong> {
<a name="978" href="#978">978</a>                 <em class="comment">// read the first line, skipping any '--' comment lines</em>
<a name="979" href="#979">979</a>                 <strong>boolean</strong> firstLine = <strong>true</strong>;
<a name="980" href="#980">980</a>                 StringBuffer buf = <strong>new</strong> StringBuffer();
<a name="981" href="#981">981</a>                 <strong>for</strong> (String line = r.readLine(); line != <strong>null</strong>; line = r.readLine()) {
<a name="982" href="#982">982</a>                     line = line.trim();
<a name="983" href="#983">983</a>                     <strong>if</strong> (line.startsWith(<span class="string">"--"</span>)) <strong>continue</strong>;
<a name="984" href="#984">984</a>                     <strong>if</strong> (line.length() == 0) <strong>continue</strong>;
<a name="985" href="#985">985</a> 
<a name="986" href="#986">986</a>                     <em class="comment">// add the line to the buffer</em>
<a name="987" href="#987">987</a>                     buf.append(' ');
<a name="988" href="#988">988</a>                     buf.append(line);
<a name="989" href="#989">989</a> 
<a name="990" href="#990">990</a>                     <em class="comment">// process if the line ends with a ';'</em>
<a name="991" href="#991">991</a>                     <strong>boolean</strong> process = line.endsWith(<span class="string">";"</span>);
<a name="992" href="#992">992</a> 
<a name="993" href="#993">993</a>                     <strong>if</strong> (!process) <strong>continue</strong>;
<a name="994" href="#994">994</a> 
<a name="995" href="#995">995</a>                     <em class="comment">// remove trailing ';'</em>
<a name="996" href="#996">996</a>                     buf.setLength(buf.length() - 1);
<a name="997" href="#997">997</a> 
<a name="998" href="#998">998</a>                     String ddl = buf.toString().trim();
<a name="999" href="#999">999</a>                     <em class="comment">// FIXME do replacements even if we do not know the type</em>
<a name="1000" href="#1000">1000</a>                     <strong>if</strong> (type != <strong>null</strong>) {
<a name="1001" href="#1001">1001</a>                         <em class="comment">// handle ddl replacements</em>
<a name="1002" href="#1002">1002</a>                         ddl = handleTypeReplacements(type, ddl);
<a name="1003" href="#1003">1003</a>                     }
<a name="1004" href="#1004">1004</a> 
<a name="1005" href="#1005">1005</a>                     <em class="comment">// run the first line as the test - if it fails, we are done</em>
<a name="1006" href="#1006">1006</a>                     <strong>if</strong> (firstLine) {
<a name="1007" href="#1007">1007</a>                         firstLine = false;
<a name="1008" href="#1008">1008</a>                         <strong>try</strong> {
<a name="1009" href="#1009">1009</a>                             <strong>if</strong> (showSQL) {
<a name="1010" href="#1010">1010</a>                                 logInfo(<span class="string">"DDL="</span>+ddl);
<a name="1011" href="#1011">1011</a>                             }
<a name="1012" href="#1012">1012</a>                             getSpringJdbcTemplate().execute(ddl);
<a name="1013" href="#1013">1013</a>                         } <strong>catch</strong> (DataAccessException e) {
<a name="1014" href="#1014">1014</a>                             <em class="comment">//log.info("Could not to execute first DDL ("+ddl+"), skipping the rest");</em>
<a name="1015" href="#1015">1015</a>                             logInfo(<span class="string">"Could not execute first DDL line, skipping the rest: "</span> + e.getMessage() + <span class="string">":"</span> + e.getCause());
<a name="1016" href="#1016">1016</a>                             <em class="comment">//e.printStackTrace();</em>
<a name="1017" href="#1017">1017</a>                             <strong>return</strong>;
<a name="1018" href="#1018">1018</a>                         }
<a name="1019" href="#1019">1019</a>                     } <strong>else</strong> {
<a name="1020" href="#1020">1020</a>                         <em class="comment">// run other lines, until done - any one can fail (we will report it)</em>
<a name="1021" href="#1021">1021</a>                         <strong>try</strong> {
<a name="1022" href="#1022">1022</a>                             <strong>if</strong> (showSQL) {
<a name="1023" href="#1023">1023</a>                                 logInfo(<span class="string">"DDL="</span>+ddl);
<a name="1024" href="#1024">1024</a>                             }
<a name="1025" href="#1025">1025</a>                             getSpringJdbcTemplate().execute(ddl);
<a name="1026" href="#1026">1026</a>                         } <strong>catch</strong> (DataAccessException e) {
<a name="1027" href="#1027">1027</a>                             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Failed while executing ddl: "</span> + e.getMessage(), e);
<a name="1028" href="#1028">1028</a>                         }
<a name="1029" href="#1029">1029</a>                     }
<a name="1030" href="#1030">1030</a>                     <strong>if</strong> (isAutoCommitDDL()) {
<a name="1031" href="#1031">1031</a>                         commitTransaction();
<a name="1032" href="#1032">1032</a>                     }
<a name="1033" href="#1033">1033</a> 
<a name="1034" href="#1034">1034</a>                     <em class="comment">// clear the buffer for next</em>
<a name="1035" href="#1035">1035</a>                     buf.setLength(0);
<a name="1036" href="#1036">1036</a>                 }
<a name="1037" href="#1037">1037</a>             } <strong>catch</strong> (IOException any) {
<a name="1038" href="#1038">1038</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Failure while processing DDL"</span>, any);
<a name="1039" href="#1039">1039</a>             } <strong>finally</strong> {
<a name="1040" href="#1040">1040</a>                 <strong>try</strong> {
<a name="1041" href="#1041">1041</a>                     r.close();
<a name="1042" href="#1042">1042</a>                 } <strong>catch</strong> (IOException any) {
<a name="1043" href="#1043">1043</a>                     <em class="comment">//log.warn("Failure while closing DDL inputstream reader", any);</em>
<a name="1044" href="#1044">1044</a>                 }
<a name="1045" href="#1045">1045</a>                 <em class="comment">// close the connection used for this DDL</em>
<a name="1046" href="#1046">1046</a>                 <strong>if</strong> (isAutoCommitDDL()) {
<a name="1047" href="#1047">1047</a>                     closeConnection();
<a name="1048" href="#1048">1048</a>                 }
<a name="1049" href="#1049">1049</a>             }
<a name="1050" href="#1050">1050</a>         } <strong>finally</strong> {
<a name="1051" href="#1051">1051</a>             <strong>try</strong> {
<a name="1052" href="#1052">1052</a>                 sqlDDL.close();
<a name="1053" href="#1053">1053</a>             } <strong>catch</strong> (IOException any) {
<a name="1054" href="#1054">1054</a>                 <em class="comment">//log.warn("Failure while closing inputstream", any);</em>
<a name="1055" href="#1055">1055</a>             }
<a name="1056" href="#1056">1056</a>         }
<a name="1057" href="#1057">1057</a>     }
<a name="1058" href="#1058">1058</a> 
<a name="1059" href="#1059">1059</a>     <em class="comment">// *********** SQL methods</em>
<a name="1060" href="#1060">1060</a> 
<a name="1061" href="#1061">1061</a>     <em>/**<em>*</em></em>
<a name="1062" href="#1062">1062</a> <em>     * Make SQL from a template</em>
<a name="1063" href="#1063">1063</a> <em>     * </em>
<a name="1064" href="#1064">1064</a> <em>     * @param sqlTemplate pass in an SQL template (one of the BASIC_* ones or make your own),</em>
<a name="1065" href="#1065">1065</a> <em>     * the replacement names will be replaced with the replacement values</em>
<a name="1066" href="#1066">1066</a> <em>     * @param tableName the name of the table for this SQL</em>
<a name="1067" href="#1067">1067</a> <em>     * @param replacements a sequence of replacement names (probably {@link #COLUMNS}, {@link #WHERE}, etc.) and values,</em>
<a name="1068" href="#1068">1068</a> <em>     * alternating like so: name,value,name,value</em>
<a name="1069" href="#1069">1069</a> <em>     * @return the SQL with all replacements made</em>
<a name="1070" href="#1070">1070</a> <em>     */</em>
<a name="1071" href="#1071">1071</a>     <strong>protected</strong> String makeSQL(String sqlTemplate, String tableName, String... replacements) {
<a name="1072" href="#1072">1072</a>         String sql = sqlTemplate;
<a name="1073" href="#1073">1073</a>         sql = sql.replace(StatementMapper.TABLE_NAME, tableName);
<a name="1074" href="#1074">1074</a>         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; replacements.length; i++) {
<a name="1075" href="#1075">1075</a>             <strong>if</strong> (replacements.length &lt; i + 1) {
<a name="1076" href="#1076">1076</a>                 <strong>break</strong>;
<a name="1077" href="#1077">1077</a>             }
<a name="1078" href="#1078">1078</a>             sql = sql.replace(replacements[i], replacements[i+1]);
<a name="1079" href="#1079">1079</a>             i++;
<a name="1080" href="#1080">1080</a>         }
<a name="1081" href="#1081">1081</a>         <em class="comment">// put in the select replacement last in case it was already replaced</em>
<a name="1082" href="#1082">1082</a>         sql = sql.replace(StatementMapper.SELECT, <span class="string">"*"</span>);
<a name="1083" href="#1083">1083</a>         <strong>return</strong> sql;
<a name="1084" href="#1084">1084</a>     }
<a name="1085" href="#1085">1085</a> 
<a name="1086" href="#1086">1086</a>     <em>/**<em>*</em></em>
<a name="1087" href="#1087">1087</a> <em>     * Handle the replacements of DDL constants in the supplied DDL with real values</em>
<a name="1088" href="#1088">1088</a> <em>     * based on the supplied type&lt;br/></em>
<a name="1089" href="#1089">1089</a> <em>     * The following keys will be replaced automatically:&lt;br/></em>
<a name="1090" href="#1090">1090</a> <em>     * {TABLENAME} - the value returned by {@link #getTableName()}&lt;br/></em>
<a name="1091" href="#1091">1091</a> <em>     * {ID} - the column name of the unique identifier&lt;br/></em>
<a name="1092" href="#1092">1092</a> <em>     * {TABLENAME:org.domain.MyClass} - the value returned by {@link #getTableName()} for the persistent type MyClass&lt;br/></em>
<a name="1093" href="#1093">1093</a> <em>     * {ID:org.domain.MyClass} - the column name of the unique identifier for the persistent type MyClass&lt;br/></em>
<a name="1094" href="#1094">1094</a> <em>     * {COLUMNNAME:propertyName} - the column name which maps to the propertyName&lt;br/></em>
<a name="1095" href="#1095">1095</a> <em>     * {IDSEQNAME} - (Oracle) a sequence name will be generated and inserted</em>
<a name="1096" href="#1096">1096</a> <em>     * based on the table name for use in generating IDs,</em>
<a name="1097" href="#1097">1097</a> <em>     * if you want to specify your own sequence name then you will lose</em>
<a name="1098" href="#1098">1098</a> <em>     * the ability to have the ID inserted into newly created objects&lt;br/></em>
<a name="1099" href="#1099">1099</a> <em>     * </em>
<a name="1100" href="#1100">1100</a> <em>     * @param type a persistent class type</em>
<a name="1101" href="#1101">1101</a> <em>     * @param ddl database definition statements (can also be SQL)</em>
<a name="1102" href="#1102">1102</a> <em>     * @return the DDL string with the {vars} replaced</em>
<a name="1103" href="#1103">1103</a> <em>     */</em>
<a name="1104" href="#1104">1104</a>     <strong>protected</strong> String handleTypeReplacements(Class&lt;?> type, String ddl) {
<a name="1105" href="#1105">1105</a>         <em class="comment">//StringBuilder sb = new StringBuilder(ddl);</em>
<a name="1106" href="#1106">1106</a>         <strong>if</strong> (type == <strong>null</strong> || ddl == <strong>null</strong>) {
<a name="1107" href="#1107">1107</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Type and ddl cannot be null"</span>);
<a name="1108" href="#1108">1108</a>         }
<a name="1109" href="#1109">1109</a>         String tableName = getTableNameFromClass(type);
<a name="1110" href="#1110">1110</a>         ddl = ddl.replace(DataMapper.DDL_TABLENAME, tableName);
<a name="1111" href="#1111">1111</a>         ddl = ddl.replace(DataMapper.DDL_ID_COLUMN, getIdColumn(type));
<a name="1112" href="#1112">1112</a>         <strong>if</strong> (DataMapper.DBTYPE_ORACLE.equals(getDatabaseType())) {
<a name="1113" href="#1113">1113</a>             ddl = ddl.replace(DataMapper.DDL_ID_SEQNAME, OracleTranslator.getOracleSeqName(tableName) );
<a name="1114" href="#1114">1114</a>         }
<a name="1115" href="#1115">1115</a>         <em class="comment">// now check for the other types and handle them if needed</em>
<a name="1116" href="#1116">1116</a>         <strong>if</strong> (ddl.contains(DataMapper.DDL_TABLENAME_TYPE_PREFIX)) {
<a name="1117" href="#1117">1117</a>             <em class="comment">// resolve the classname for a tablename</em>
<a name="1118" href="#1118">1118</a>             List&lt;Class&lt;?>> pClasses = getPersistentClasses();
<a name="1119" href="#1119">1119</a>             <strong>for</strong> (Class&lt;?> pType : pClasses) {
<a name="1120" href="#1120">1120</a>                 <em class="comment">// attempt to replace all parent tablenames</em>
<a name="1121" href="#1121">1121</a>                 String tName = getTableNameFromClass(pType);
<a name="1122" href="#1122">1122</a>                 ddl = ddl.replace(DataMapper.DDL_TABLENAME_TYPE_PREFIX + pType.getName() + <span class="string">"}"</span>, tName);
<a name="1123" href="#1123">1123</a>                 ddl = ddl.replace(DataMapper.DDL_TABLENAME_TYPE_PREFIX + pType.getSimpleName() + <span class="string">"}"</span>, tName);
<a name="1124" href="#1124">1124</a>             }
<a name="1125" href="#1125">1125</a>         }
<a name="1126" href="#1126">1126</a>         <strong>if</strong> (ddl.contains(DataMapper.DDL_ID_TYPE_PREFIX)) {
<a name="1127" href="#1127">1127</a>             <em class="comment">// resolve the classname for a tablename</em>
<a name="1128" href="#1128">1128</a>             List&lt;Class&lt;?>> pClasses = getPersistentClasses();
<a name="1129" href="#1129">1129</a>             <strong>for</strong> (Class&lt;?> pType : pClasses) {
<a name="1130" href="#1130">1130</a>                 <em class="comment">// attempt to replace all parent tablenames</em>
<a name="1131" href="#1131">1131</a>                 String pId = getIdColumn(pType);
<a name="1132" href="#1132">1132</a>                 ddl = ddl.replace(DataMapper.DDL_ID_TYPE_PREFIX + pType.getName() + <span class="string">"}"</span>, pId);
<a name="1133" href="#1133">1133</a>                 ddl = ddl.replace(DataMapper.DDL_ID_TYPE_PREFIX + pType.getSimpleName() + <span class="string">"}"</span>, pId);
<a name="1134" href="#1134">1134</a>             }
<a name="1135" href="#1135">1135</a>         }
<a name="1136" href="#1136">1136</a>         <strong>if</strong> (ddl.contains(DataMapper.DDL_COLUMN_PREFIX)) {
<a name="1137" href="#1137">1137</a>             <em class="comment">// resolve the classname for a tablename</em>
<a name="1138" href="#1138">1138</a>             <a href="../../../../org/sakaiproject/genericdao/api/mappers/NamesRecord.html">NamesRecord</a> nr = getNamesRecord(type);
<a name="1139" href="#1139">1139</a>             <strong>for</strong> (String property : nr.getPropertyNames()) {
<a name="1140" href="#1140">1140</a>                 <em class="comment">// attempt to replace all property names</em>
<a name="1141" href="#1141">1141</a>                 String column = nr.getColumnForProperty(property);
<a name="1142" href="#1142">1142</a>                 ddl = ddl.replace(DataMapper.DDL_COLUMN_PREFIX + property + <span class="string">"}"</span>, column);
<a name="1143" href="#1143">1143</a>             }
<a name="1144" href="#1144">1144</a>             <em class="comment">// TODO support for columns by type?</em>
<a name="1145" href="#1145">1145</a>         }
<a name="1146" href="#1146">1146</a>         <strong>return</strong> ddl;
<a name="1147" href="#1147">1147</a>     }
<a name="1148" href="#1148">1148</a> 
<a name="1149" href="#1149">1149</a>     <em>/**<em>*</em></em>
<a name="1150" href="#1150">1150</a> <em>     * Create comparison SQL but converts the value object to a string</em>
<a name="1151" href="#1151">1151</a> <em>     * </em>
<a name="1152" href="#1152">1152</a> <em>     * @param column the name of a database column</em>
<a name="1153" href="#1153">1153</a> <em>     * @param comparisonConstant the comparison constant (e.g. EQUALS)</em>
<a name="1154" href="#1154">1154</a> <em>     * @param value the value to compare the property to</em>
<a name="1155" href="#1155">1155</a> <em>     * @return a string representing the SQL snippet (e.g. propA = ?)</em>
<a name="1156" href="#1156">1156</a> <em>     */</em>
<a name="1157" href="#1157">1157</a>     <strong>protected</strong> String makeComparisonSQL(String column, <strong>int</strong> comparisonConstant, Object value) {
<a name="1158" href="#1158">1158</a>         <strong>return</strong> JDBCUtils.makeComparisonSQL(column, comparisonConstant, value);
<a name="1159" href="#1159">1159</a>     }
<a name="1160" href="#1160">1160</a> 
<a name="1161" href="#1161">1161</a>     <em>/**<em>*</em></em>
<a name="1162" href="#1162">1162</a> <em>     * @param params a set of params to add this value to</em>
<a name="1163" href="#1163">1163</a> <em>     * @param column the name of a database column</em>
<a name="1164" href="#1164">1164</a> <em>     * @param comparisonConstant the comparison constant (e.g. EQUALS)</em>
<a name="1165" href="#1165">1165</a> <em>     * @param value the value to compare the property to</em>
<a name="1166" href="#1166">1166</a> <em>     * @return a string representing the SQL snippet (e.g. propA = ?)</em>
<a name="1167" href="#1167">1167</a> <em>     */</em>
<a name="1168" href="#1168">1168</a>     <strong>protected</strong> String makeComparisonSQL(List&lt;Object> params, String column, <strong>int</strong> comparisonConstant, Object value) {
<a name="1169" href="#1169">1169</a>         <strong>return</strong> JDBCUtils.makeComparisonSQL(params, column, comparisonConstant, value);
<a name="1170" href="#1170">1170</a>     }
<a name="1171" href="#1171">1171</a> 
<a name="1172" href="#1172">1172</a> 
<a name="1173" href="#1173">1173</a>     <em class="comment">// ** Transaction methods</em>
<a name="1174" href="#1174">1174</a> 
<a name="1175" href="#1175">1175</a>     <em>/**<em>*</em></em>
<a name="1176" href="#1176">1176</a> <em>     * This will do a commit on the current DB Connection on this thread,</em>
<a name="1177" href="#1177">1177</a> <em>     * allows the developer to force a commit immediately &lt;br/></em>
<a name="1178" href="#1178">1178</a> <em>     * Remember to close your connection if you are completely done with it</em>
<a name="1179" href="#1179">1179</a> <em>     * </em>
<a name="1180" href="#1180">1180</a> <em>     * @return true if it committed successfully</em>
<a name="1181" href="#1181">1181</a> <em>     */</em>
<a name="1182" href="#1182">1182</a>     <strong>public</strong> <strong>boolean</strong> commitTransaction() {
<a name="1183" href="#1183">1183</a>         <strong>boolean</strong> success = false;
<a name="1184" href="#1184">1184</a>         Connection conn = getConnection();
<a name="1185" href="#1185">1185</a>         <strong>boolean</strong> previousAutocommit = false;
<a name="1186" href="#1186">1186</a>         <strong>try</strong> {
<a name="1187" href="#1187">1187</a>             previousAutocommit = conn.getAutoCommit();
<a name="1188" href="#1188">1188</a>             conn.commit();
<a name="1189" href="#1189">1189</a>             conn.setAutoCommit(previousAutocommit);
<a name="1190" href="#1190">1190</a>             success = <strong>true</strong>;
<a name="1191" href="#1191">1191</a>         } <strong>catch</strong> (SQLException e) {
<a name="1192" href="#1192">1192</a>             logWarn(<span class="string">"Could not commit sucessfully: "</span> + e.getMessage());
<a name="1193" href="#1193">1193</a>             success = false;
<a name="1194" href="#1194">1194</a>             <strong>try</strong> {
<a name="1195" href="#1195">1195</a>                 conn.setAutoCommit(previousAutocommit);
<a name="1196" href="#1196">1196</a>             } <strong>catch</strong> (SQLException e1) {
<a name="1197" href="#1197">1197</a>                 <em class="comment">// nothing to do here but continue</em>
<a name="1198" href="#1198">1198</a>             }
<a name="1199" href="#1199">1199</a>         }
<a name="1200" href="#1200">1200</a>         <em class="comment">// removed: try-finally-releaseConnection(conn);</em>
<a name="1201" href="#1201">1201</a>         <strong>return</strong> success;
<a name="1202" href="#1202">1202</a>     }
<a name="1203" href="#1203">1203</a> 
<a name="1204" href="#1204">1204</a>     <em>/**<em>*</em></em>
<a name="1205" href="#1205">1205</a> <em>     * This will do a rollback on the DB Connection on this thread,</em>
<a name="1206" href="#1206">1206</a> <em>     * allows the developer to force an immediate rollback &lt;br/></em>
<a name="1207" href="#1207">1207</a> <em>     * Remember to close your connection if you are completely done with it</em>
<a name="1208" href="#1208">1208</a> <em>     * </em>
<a name="1209" href="#1209">1209</a> <em>     * @return true if the rollback executed successfully</em>
<a name="1210" href="#1210">1210</a> <em>     */</em>
<a name="1211" href="#1211">1211</a>     <strong>public</strong> <strong>boolean</strong> rollbackTransaction() {
<a name="1212" href="#1212">1212</a>         <strong>boolean</strong> success = false;
<a name="1213" href="#1213">1213</a>         Connection conn = getConnection();
<a name="1214" href="#1214">1214</a>         <strong>boolean</strong> previousAutocommit = false;
<a name="1215" href="#1215">1215</a>         <strong>try</strong> {
<a name="1216" href="#1216">1216</a>             previousAutocommit = conn.getAutoCommit();
<a name="1217" href="#1217">1217</a>             conn.rollback();
<a name="1218" href="#1218">1218</a>             conn.setAutoCommit(previousAutocommit);
<a name="1219" href="#1219">1219</a>             success = <strong>true</strong>;
<a name="1220" href="#1220">1220</a>         } <strong>catch</strong> (SQLException e) {
<a name="1221" href="#1221">1221</a>             logWarn(<span class="string">"Could not rollback sucessfully: "</span> + e.getMessage());
<a name="1222" href="#1222">1222</a>             success = false;
<a name="1223" href="#1223">1223</a>             <strong>try</strong> {
<a name="1224" href="#1224">1224</a>                 conn.setAutoCommit(previousAutocommit);
<a name="1225" href="#1225">1225</a>             } <strong>catch</strong> (SQLException e1) {
<a name="1226" href="#1226">1226</a>                 <em class="comment">// nothing to do here but continue</em>
<a name="1227" href="#1227">1227</a>             }
<a name="1228" href="#1228">1228</a>         }
<a name="1229" href="#1229">1229</a>         <em class="comment">// removed: try-finally-releaseConnection(conn);</em>
<a name="1230" href="#1230">1230</a>         <strong>return</strong> success;
<a name="1231" href="#1231">1231</a>     }
<a name="1232" href="#1232">1232</a> 
<a name="1233" href="#1233">1233</a>     <em>/**<em>*</em></em>
<a name="1234" href="#1234">1234</a> <em>     * Allows a developer to do a manual release of the connection,</em>
<a name="1235" href="#1235">1235</a> <em>     * this will cause a new connection to be obtained the next time a method is executed,</em>
<a name="1236" href="#1236">1236</a> <em>     * anything not yet committed for this connection will be rolled back and lost,</em>
<a name="1237" href="#1237">1237</a> <em>     * normally if you are using a DataSource which pools connections then you do not</em>
<a name="1238" href="#1238">1238</a> <em>     * need to worry about this too much, just do it at the end of your work unit</em>
<a name="1239" href="#1239">1239</a> <em>     * </em>
<a name="1240" href="#1240">1240</a> <em>     * @return true if the connection was closed</em>
<a name="1241" href="#1241">1241</a> <em>     */</em>
<a name="1242" href="#1242">1242</a>     <strong>public</strong> <strong>boolean</strong> closeConnection() {
<a name="1243" href="#1243">1243</a>         <strong>boolean</strong> success = false;
<a name="1244" href="#1244">1244</a>         <strong>try</strong> {
<a name="1245" href="#1245">1245</a>             Connection conn = getConnection();
<a name="1246" href="#1246">1246</a>             <strong>try</strong> {
<a name="1247" href="#1247">1247</a>                 conn.rollback();
<a name="1248" href="#1248">1248</a>             } <strong>catch</strong> (Exception e) {
<a name="1249" href="#1249">1249</a>                 <em class="comment">// oh well, keep going</em>
<a name="1250" href="#1250">1250</a>             }
<a name="1251" href="#1251">1251</a>             DataSourceUtils.doReleaseConnection(conn, getDataSource());
<a name="1252" href="#1252">1252</a>             success = <strong>true</strong>;
<a name="1253" href="#1253">1253</a>         } <strong>catch</strong> (CannotGetJdbcConnectionException e) {
<a name="1254" href="#1254">1254</a>             logWarn(<span class="string">"Could not close connection sucessfully: "</span> + e.getMessage());
<a name="1255" href="#1255">1255</a>         } <strong>catch</strong> (SQLException e) {
<a name="1256" href="#1256">1256</a>             logWarn(<span class="string">"Could not close connection sucessfully: "</span> + e.getMessage());
<a name="1257" href="#1257">1257</a>         }
<a name="1258" href="#1258">1258</a>         <strong>return</strong> success;
<a name="1259" href="#1259">1259</a>     }
<a name="1260" href="#1260">1260</a> 
<a name="1261" href="#1261">1261</a>     <em class="comment">// PUBLIC IMPLS</em>
<a name="1262" href="#1262">1262</a> 
<a name="1263" href="#1263">1263</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1264" href="#1264">1264</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.GenericDao#getIdProperty(java.lang.Class)</em>
<a name="1265" href="#1265">1265</a> <em class="comment">     */</em>
<a name="1266" href="#1266">1266</a>     <strong>public</strong> String getIdProperty(Class&lt;?> type) {
<a name="1267" href="#1267">1267</a>         String idProp;
<a name="1268" href="#1268">1268</a>         <strong>try</strong> {
<a name="1269" href="#1269">1269</a>             idProp = getNamesRecord(type).getIdProperty();
<a name="1270" href="#1270">1270</a>             <strong>if</strong> (idProp == <strong>null</strong> &amp;&amp; classes.contains(type)) {
<a name="1271" href="#1271">1271</a>                 idProp = <span class="string">"id"</span>;
<a name="1272" href="#1272">1272</a>             }
<a name="1273" href="#1273">1273</a>         } <strong>catch</strong> (IllegalArgumentException e) {
<a name="1274" href="#1274">1274</a>             idProp = <strong>null</strong>;
<a name="1275" href="#1275">1275</a>         }
<a name="1276" href="#1276">1276</a>         <strong>return</strong> idProp;
<a name="1277" href="#1277">1277</a>     }
<a name="1278" href="#1278">1278</a> 
<a name="1279" href="#1279">1279</a>     <em>/**<em>*</em></em>
<a name="1280" href="#1280">1280</a> <em>     * MUST be overridden</em>
<a name="1281" href="#1281">1281</a> <em>     */</em>
<a name="1282" href="#1282">1282</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="1283" href="#1283">1283</a>     <strong>protected</strong> &lt;T> T baseFindById(Class&lt;T> type, Serializable id) {
<a name="1284" href="#1284">1284</a>         String idColumn = getIdColumn(type);
<a name="1285" href="#1285">1285</a>         String sql = makeSQL(getSelectTemplate(type), getTableNameFromClass(type), StatementMapper.WHERE, <span class="string">"where "</span> + getIdColumn(type) + <span class="string">" = ?"</span>);
<a name="1286" href="#1286">1286</a>         T entity = <strong>null</strong>;
<a name="1287" href="#1287">1287</a>         <strong>try</strong> {
<a name="1288" href="#1288">1288</a>             <em class="comment">// convert the type if needed</em>
<a name="1289" href="#1289">1289</a>             <strong>try</strong> {
<a name="1290" href="#1290">1290</a>                 id = (Serializable) convertColumn(type, idColumn, id);
<a name="1291" href="#1291">1291</a>             } <strong>catch</strong> (ClassCastException e) {
<a name="1292" href="#1292">1292</a>                 <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"all ids must be Serializable, change the property type defined in the names record for the id to be a Serializable type: "</span> + e.getMessage(), e);
<a name="1293" href="#1293">1293</a>             }
<a name="1294" href="#1294">1294</a>             <em class="comment">// get the map of values</em>
<a name="1295" href="#1295">1295</a>             Object[] params = <strong>new</strong> Object[] {id};
<a name="1296" href="#1296">1296</a>             <strong>if</strong> (showSQL) {
<a name="1297" href="#1297">1297</a>                 logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+ArrayUtils.arrayToString(params));
<a name="1298" href="#1298">1298</a>             }
<a name="1299" href="#1299">1299</a>             Map&lt;String, Object> data = getSpringJdbcTemplate().queryForMap(sql, params);
<a name="1300" href="#1300">1300</a>             entity = makeEntityFromMap(type, data);
<a name="1301" href="#1301">1301</a>         } <strong>catch</strong> (IncorrectResultSizeDataAccessException e) {
<a name="1302" href="#1302">1302</a>             entity = <strong>null</strong>;
<a name="1303" href="#1303">1303</a>         }
<a name="1304" href="#1304">1304</a> 
<a name="1305" href="#1305">1305</a>         <strong>return</strong> entity;
<a name="1306" href="#1306">1306</a>     }
<a name="1307" href="#1307">1307</a> 
<a name="1308" href="#1308">1308</a>     <em>/**<em>*</em></em>
<a name="1309" href="#1309">1309</a> <em>     * MUST be overridden</em>
<a name="1310" href="#1310">1310</a> <em>     */</em>
<a name="1311" href="#1311">1311</a>     <strong>protected</strong> Serializable baseCreate(Class&lt;?> type, Object object) {
<a name="1312" href="#1312">1312</a>         StringBuilder rKeys = <strong>new</strong> StringBuilder();
<a name="1313" href="#1313">1313</a>         StringBuilder rVals = <strong>new</strong> StringBuilder();
<a name="1314" href="#1314">1314</a>         ArrayList&lt;Object> replacementValues = <strong>new</strong> ArrayList&lt;Object>();
<a name="1315" href="#1315">1315</a> 
<a name="1316" href="#1316">1316</a>         Map&lt;String, Object> values = makeMapFromEntity(object);
<a name="1317" href="#1317">1317</a>         String idColumn = getIdColumn(type);
<a name="1318" href="#1318">1318</a>         String tableName = getTableNameFromClass(type);
<a name="1319" href="#1319">1319</a>         Object idValue = <strong>null</strong>;
<a name="1320" href="#1320">1320</a>         <strong>int</strong> counter = 0;
<a name="1321" href="#1321">1321</a>         <strong>for</strong> (Entry&lt;String, Object> entry : values.entrySet()) {
<a name="1322" href="#1322">1322</a>             String column = entry.getKey();
<a name="1323" href="#1323">1323</a>             Object value = entry.getValue();
<a name="1324" href="#1324">1324</a>             <em class="comment">// convert the value if needed</em>
<a name="1325" href="#1325">1325</a>             value = convertColumn(type, column, value);
<a name="1326" href="#1326">1326</a>             <em class="comment">// handle the id column specially</em>
<a name="1327" href="#1327">1327</a>             <strong>if</strong> (idColumn.equals(column)) {
<a name="1328" href="#1328">1328</a>                 idValue = value;
<a name="1329" href="#1329">1329</a>                 <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="1330" href="#1330">1330</a>                     <strong>continue</strong>; <em class="comment">// expect to autogenerate an id</em>
<a name="1331" href="#1331">1331</a>                 }
<a name="1332" href="#1332">1332</a>                 <em class="comment">// id was specified so use that instead of autogenerating</em>
<a name="1333" href="#1333">1333</a>             }
<a name="1334" href="#1334">1334</a>             <strong>if</strong> (counter > 0) {
<a name="1335" href="#1335">1335</a>                 rKeys.append(<span class="string">","</span>);
<a name="1336" href="#1336">1336</a>                 rVals.append(<span class="string">","</span>);
<a name="1337" href="#1337">1337</a>             }
<a name="1338" href="#1338">1338</a>             rKeys.append(column);
<a name="1339" href="#1339">1339</a>             rVals.append(<span class="string">"?"</span>);
<a name="1340" href="#1340">1340</a>             replacementValues.add(value);
<a name="1341" href="#1341">1341</a>             counter++;
<a name="1342" href="#1342">1342</a>         }
<a name="1343" href="#1343">1343</a> 
<a name="1344" href="#1344">1344</a>         String sql = makeSQL(getInsertTemplate(type), tableName, StatementMapper.COLUMNS, rKeys.toString(), 
<a name="1345" href="#1345">1345</a>                 StatementMapper.VALUES, rVals.toString());
<a name="1346" href="#1346">1346</a>         <strong>if</strong> (showSQL) {
<a name="1347" href="#1347">1347</a>             logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+replacementValues);
<a name="1348" href="#1348">1348</a>         }
<a name="1349" href="#1349">1349</a>         <strong>int</strong> rows = getSpringJdbcTemplate().update(sql, replacementValues.toArray(<strong>new</strong> Object[replacementValues.size()]));
<a name="1350" href="#1350">1350</a>         <strong>if</strong> (rows &lt;= 0) {
<a name="1351" href="#1351">1351</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Could not create DB insert based on object: "</span> + object);
<a name="1352" href="#1352">1352</a>         }
<a name="1353" href="#1353">1353</a> 
<a name="1354" href="#1354">1354</a>         String idProperty = getIdProperty(type);
<a name="1355" href="#1355">1355</a>         Class&lt;?> idType = ReflectUtils.getInstance().getFieldType(type, idProperty);
<a name="1356" href="#1356">1356</a>         <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="1357" href="#1357">1357</a>             <em class="comment">// now get the new id and put it in the object</em>
<a name="1358" href="#1358">1358</a>             <strong>try</strong> {
<a name="1359" href="#1359">1359</a>                 String idSQL = getDatabaseTranslator().makeAutoIdQuery(tableName, idColumn);
<a name="1360" href="#1360">1360</a>                 <strong>if</strong> (showSQL) {
<a name="1361" href="#1361">1361</a>                     logInfo(<span class="string">"SQL="</span>+idSQL);
<a name="1362" href="#1362">1362</a>                 }
<a name="1363" href="#1363">1363</a>                 idValue = getSpringJdbcTemplate().queryForObject(idSQL, idType);
<a name="1364" href="#1364">1364</a>                 <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="1365" href="#1365">1365</a>                     <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"Null value for new id retrieved from DB"</span>);
<a name="1366" href="#1366">1366</a>                 }
<a name="1367" href="#1367">1367</a>                 ReflectUtils.getInstance().setFieldValue(object, idProperty, idValue);
<a name="1368" href="#1368">1368</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="1369" href="#1369">1369</a>                 <strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Could not get back the autogenerated ID of the newly inserted object: "</span> + object + <span class="string">" :"</span> + e.getMessage(), e);
<a name="1370" href="#1370">1370</a>             }
<a name="1371" href="#1371">1371</a>         }
<a name="1372" href="#1372">1372</a>         <strong>if</strong> (! Serializable.<strong>class</strong>.isAssignableFrom(idValue.getClass())) {
<a name="1373" href="#1373">1373</a>             idValue = idValue.toString();
<a name="1374" href="#1374">1374</a>         }
<a name="1375" href="#1375">1375</a>         <strong>return</strong> (Serializable) idValue;
<a name="1376" href="#1376">1376</a>     }
<a name="1377" href="#1377">1377</a> 
<a name="1378" href="#1378">1378</a>     <em>/**<em>*</em></em>
<a name="1379" href="#1379">1379</a> <em>     * MUST be overridden</em>
<a name="1380" href="#1380">1380</a> <em>     */</em>
<a name="1381" href="#1381">1381</a>     <strong>protected</strong> <strong>void</strong> baseUpdate(Class&lt;?> type, Object id, Object object) {
<a name="1382" href="#1382">1382</a>         String idColumn = getIdColumn(type);
<a name="1383" href="#1383">1383</a>         StringBuilder update = <strong>new</strong> StringBuilder();
<a name="1384" href="#1384">1384</a>         ArrayList&lt;Object> replacementValues = <strong>new</strong> ArrayList&lt;Object>();
<a name="1385" href="#1385">1385</a> 
<a name="1386" href="#1386">1386</a>         Map&lt;String, Object> values = makeMapFromEntity(object);
<a name="1387" href="#1387">1387</a>         <strong>int</strong> counter = 0;
<a name="1388" href="#1388">1388</a>         <strong>for</strong> (Entry&lt;String, Object> entry : values.entrySet()) {
<a name="1389" href="#1389">1389</a>             String column = entry.getKey();
<a name="1390" href="#1390">1390</a>             Object value = entry.getValue();
<a name="1391" href="#1391">1391</a>             <em class="comment">// convert the value if needed</em>
<a name="1392" href="#1392">1392</a>             value = convertColumn(type, column, value);
<a name="1393" href="#1393">1393</a>             <strong>if</strong> (idColumn.equals(column)) {
<a name="1394" href="#1394">1394</a>                 <strong>continue</strong>; <em class="comment">// skip the id on the first pass</em>
<a name="1395" href="#1395">1395</a>             }
<a name="1396" href="#1396">1396</a>             <strong>if</strong> (counter > 0) {
<a name="1397" href="#1397">1397</a>                 update.append(<span class="string">","</span>);
<a name="1398" href="#1398">1398</a>             }
<a name="1399" href="#1399">1399</a>             update.append(column);
<a name="1400" href="#1400">1400</a>             update.append(<span class="string">"=?"</span>);
<a name="1401" href="#1401">1401</a>             replacementValues.add(value);
<a name="1402" href="#1402">1402</a>             counter++;
<a name="1403" href="#1403">1403</a>         }
<a name="1404" href="#1404">1404</a>         <em class="comment">// add the id in at the end</em>
<a name="1405" href="#1405">1405</a>         replacementValues.add(id);
<a name="1406" href="#1406">1406</a> 
<a name="1407" href="#1407">1407</a>         <em class="comment">// do the update</em>
<a name="1408" href="#1408">1408</a>         String sql = makeSQL(getUpdateTemplate(type), getTableNameFromClass(type), 
<a name="1409" href="#1409">1409</a>                 StatementMapper.UPDATE, update.toString(), StatementMapper.WHERE, <span class="string">"where "</span> + idColumn + <span class="string">" = ?"</span>);
<a name="1410" href="#1410">1410</a>         <strong>if</strong> (showSQL) {
<a name="1411" href="#1411">1411</a>             logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+replacementValues);
<a name="1412" href="#1412">1412</a>         }
<a name="1413" href="#1413">1413</a>         <strong>int</strong> rows = getSpringJdbcTemplate().update(sql, replacementValues.toArray(<strong>new</strong> Object[replacementValues.size()]));
<a name="1414" href="#1414">1414</a>         <strong>if</strong> (rows &lt;= 0) {
<a name="1415" href="#1415">1415</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Could not update entity based on object: "</span> + object);
<a name="1416" href="#1416">1416</a>         }
<a name="1417" href="#1417">1417</a>     }
<a name="1418" href="#1418">1418</a> 
<a name="1419" href="#1419">1419</a>     <em>/**<em>*</em></em>
<a name="1420" href="#1420">1420</a> <em>     * MUST be overridden</em>
<a name="1421" href="#1421">1421</a> <em>     */</em>
<a name="1422" href="#1422">1422</a>     <strong>protected</strong> &lt;T> <strong>boolean</strong> baseDelete(Class&lt;T> type, Serializable id) {
<a name="1423" href="#1423">1423</a>         String idColumn = getIdColumn(type);
<a name="1424" href="#1424">1424</a>         String sql = makeSQL(getDeleteTemplate(type), getTableNameFromClass(type), 
<a name="1425" href="#1425">1425</a>                 StatementMapper.WHERE, <span class="string">"where "</span> + idColumn + <span class="string">" = ?"</span>);
<a name="1426" href="#1426">1426</a>         <em class="comment">// convert the type if needed</em>
<a name="1427" href="#1427">1427</a>         <strong>try</strong> {
<a name="1428" href="#1428">1428</a>             id = (Serializable) convertColumn(type, idColumn, id);
<a name="1429" href="#1429">1429</a>         } <strong>catch</strong> (ClassCastException e) {
<a name="1430" href="#1430">1430</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"all ids must be Serializable, change the property type defined in the names record for the id to be a Serializable type: "</span> + e.getMessage(), e);
<a name="1431" href="#1431">1431</a>         }
<a name="1432" href="#1432">1432</a>         Object[] params = <strong>new</strong> Object[] {id};
<a name="1433" href="#1433">1433</a>         <strong>if</strong> (showSQL) {
<a name="1434" href="#1434">1434</a>             logInfo(<span class="string">"SQL="</span>+sql+<span class="string">":\n Params="</span>+ArrayUtils.arrayToString(params));
<a name="1435" href="#1435">1435</a>         }
<a name="1436" href="#1436">1436</a>         <strong>int</strong> rows = getSpringJdbcTemplate().update(sql, params);
<a name="1437" href="#1437">1437</a>         <strong>return</strong> rows > 0;
<a name="1438" href="#1438">1438</a>     }
<a name="1439" href="#1439">1439</a> 
<a name="1440" href="#1440">1440</a> 
<a name="1441" href="#1441">1441</a>     <em>/**<em>*</em></em>
<a name="1442" href="#1442">1442</a> <em>     * Override this if desired</em>
<a name="1443" href="#1443">1443</a> <em>     */</em>
<a name="1444" href="#1444">1444</a>     <strong>protected</strong> Serializable baseGetIdValue(Object object) {
<a name="1445" href="#1445">1445</a>         Class&lt;?> type = object.getClass();
<a name="1446" href="#1446">1446</a>         String idProp = getIdProperty(type);
<a name="1447" href="#1447">1447</a>         Object idValue = <strong>null</strong>;
<a name="1448" href="#1448">1448</a>         <strong>if</strong> (idProp == <strong>null</strong>) {
<a name="1449" href="#1449">1449</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not find id property for this class type: "</span> + type);
<a name="1450" href="#1450">1450</a>         } <strong>else</strong> {
<a name="1451" href="#1451">1451</a>             idValue = ReflectUtils.getInstance().getFieldValue(object, idProp);
<a name="1452" href="#1452">1452</a>         }
<a name="1453" href="#1453">1453</a>         Serializable serialId = <strong>null</strong>;
<a name="1454" href="#1454">1454</a>         <strong>if</strong> (idValue != <strong>null</strong>) {
<a name="1455" href="#1455">1455</a>             <strong>if</strong> (idValue instanceof Serializable) {
<a name="1456" href="#1456">1456</a>                 serialId = (Serializable) idValue;
<a name="1457" href="#1457">1457</a>             } <strong>else</strong> {
<a name="1458" href="#1458">1458</a>                 serialId = idValue.toString();
<a name="1459" href="#1459">1459</a>             }
<a name="1460" href="#1460">1460</a>         }
<a name="1461" href="#1461">1461</a>         <strong>return</strong> serialId;
<a name="1462" href="#1462">1462</a>     }
<a name="1463" href="#1463">1463</a> 
<a name="1464" href="#1464">1464</a>     <em>/**<em>*</em></em>
<a name="1465" href="#1465">1465</a> <em>     * Find the class type of a persistent object,</em>
<a name="1466" href="#1466">1466</a> <em>     * needed in the case that we are working with something that wraps it's objects&lt;br/></em>
<a name="1467" href="#1467">1467</a> <em>     * Override this if desired</em>
<a name="1468" href="#1468">1468</a> <em>     * @param entity a persistent entity</em>
<a name="1469" href="#1469">1469</a> <em>     * @return the persistent class type OR null if it cannot be found</em>
<a name="1470" href="#1470">1470</a> <em>     */</em>
<a name="1471" href="#1471">1471</a>     <strong>protected</strong> Class&lt;?> findClass(Object entity) {
<a name="1472" href="#1472">1472</a>         <strong>if</strong> (entity == <strong>null</strong>) {
<a name="1473" href="#1473">1473</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot find class type of null entity object"</span>);
<a name="1474" href="#1474">1474</a>         }
<a name="1475" href="#1475">1475</a>         Class&lt;?> type = entity.getClass();
<a name="1476" href="#1476">1476</a>         <strong>return</strong> type;
<a name="1477" href="#1477">1477</a>     }
<a name="1478" href="#1478">1478</a> 
<a name="1479" href="#1479">1479</a>     <em class="comment">// COMMON CODE</em>
<a name="1480" href="#1480">1480</a> 
<a name="1481" href="#1481">1481</a>     <strong>private</strong> List&lt;Class&lt;?>> classes;
<a name="1482" href="#1482">1482</a>     <em>/**<em>*</em></em>
<a name="1483" href="#1483">1483</a> <em>     * This does a nice bit of exception handling for us and verifies that</em>
<a name="1484" href="#1484">1484</a> <em>     * this class is valid to perform a DAO operation with</em>
<a name="1485" href="#1485">1485</a> <em>     * @param type class type of the persistent object to check</em>
<a name="1486" href="#1486">1486</a> <em>     * @return A valid entityClass type resolved to be the same as</em>
<a name="1487" href="#1487">1487</a> <em>     * the ones usable by this DAO</em>
<a name="1488" href="#1488">1488</a> <em>     */</em>
<a name="1489" href="#1489">1489</a>     <strong>protected</strong> Class&lt;?> checkClass(Class&lt;?> type) {
<a name="1490" href="#1490">1490</a>         <strong>if</strong> (type == <strong>null</strong>) {
<a name="1491" href="#1491">1491</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"type cannot be null"</span>);
<a name="1492" href="#1492">1492</a>         }
<a name="1493" href="#1493">1493</a> 
<a name="1494" href="#1494">1494</a>         <strong>if</strong> (classes == <strong>null</strong>) {
<a name="1495" href="#1495">1495</a>             <strong>throw</strong> <strong>new</strong> NullPointerException(<span class="string">"persistent classes must be set"</span>);
<a name="1496" href="#1496">1496</a>         }
<a name="1497" href="#1497">1497</a> 
<a name="1498" href="#1498">1498</a>         <strong>for</strong> (Iterator&lt;Class&lt;?>> i = classes.iterator(); i.hasNext();) {
<a name="1499" href="#1499">1499</a>             Class&lt;?> concrete = (Class&lt;?>) i.next();
<a name="1500" href="#1500">1500</a>             <strong>if</strong> (concrete.isAssignableFrom(type)) {
<a name="1501" href="#1501">1501</a>                 <strong>return</strong> concrete;
<a name="1502" href="#1502">1502</a>             }
<a name="1503" href="#1503">1503</a>         }
<a name="1504" href="#1504">1504</a>         <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not resolve this class "</span> + 
<a name="1505" href="#1505">1505</a>                 type + <span class="string">" as part of the set of persistent objects: "</span> +
<a name="1506" href="#1506">1506</a>                 classes.toString());
<a name="1507" href="#1507">1507</a>     }
<a name="1508" href="#1508">1508</a> 
<a name="1509" href="#1509">1509</a>     <strong>private</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider;
<a name="1510" href="#1510">1510</a>     <em>/**<em>*</em></em>
<a name="1511" href="#1511">1511</a> <em>     * @return the current cache provider</em>
<a name="1512" href="#1512">1512</a> <em>     */</em>
<a name="1513" href="#1513">1513</a>     <strong>protected</strong> <a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> getCacheProvider() {
<a name="1514" href="#1514">1514</a>         <strong>if</strong> (cacheProvider == <strong>null</strong>) {
<a name="1515" href="#1515">1515</a>             cacheProvider = <strong>new</strong> <a href="../../../../org/sakaiproject/genericdao/base/caching/NonCachingCacheProvider.html">NonCachingCacheProvider</a>();
<a name="1516" href="#1516">1516</a>         }
<a name="1517" href="#1517">1517</a>         <strong>return</strong> cacheProvider;
<a name="1518" href="#1518">1518</a>     }
<a name="1519" href="#1519">1519</a>     <em>/**<em>*</em></em>
<a name="1520" href="#1520">1520</a> <em>     * Set the cache provider to an implementation of {@link CacheProvider},</em>
<a name="1521" href="#1521">1521</a> <em>     * this will be set to {@link NonCachingCacheProvider} if this is not set explicitly</em>
<a name="1522" href="#1522">1522</a> <em>     * @param cacheProvider</em>
<a name="1523" href="#1523">1523</a> <em>     */</em>
<a name="1524" href="#1524">1524</a>     <strong>public</strong> <strong>void</strong> setCacheProvider(<a href="../../../../org/sakaiproject/genericdao/api/caching/CacheProvider.html">CacheProvider</a> cacheProvider) {
<a name="1525" href="#1525">1525</a>         <strong>this</strong>.cacheProvider = cacheProvider;
<a name="1526" href="#1526">1526</a>     }
<a name="1527" href="#1527">1527</a>     <em>/**<em>*</em></em>
<a name="1528" href="#1528">1528</a> <em>     * @return the cache name used for storing this type of persistent object</em>
<a name="1529" href="#1529">1529</a> <em>     */</em>
<a name="1530" href="#1530">1530</a>     <strong>protected</strong> String getCacheName(Class&lt;?> type) {
<a name="1531" href="#1531">1531</a>         <strong>if</strong> (type == <strong>null</strong>) {
<a name="1532" href="#1532">1532</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="1533" href="#1533">1533</a>         }
<a name="1534" href="#1534">1534</a>         <strong>return</strong> type.getName();
<a name="1535" href="#1535">1535</a>     }
<a name="1536" href="#1536">1536</a>     <em>/**<em>*</em></em>
<a name="1537" href="#1537">1537</a> <em>     * @return the cachename used for storing search results for this type of object</em>
<a name="1538" href="#1538">1538</a> <em>     */</em>
<a name="1539" href="#1539">1539</a>     <strong>protected</strong> String getSearchCacheName(Class&lt;?> type) {
<a name="1540" href="#1540">1540</a>         <strong>if</strong> (type == <strong>null</strong>) {
<a name="1541" href="#1541">1541</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"type cannot be null"</span>);
<a name="1542" href="#1542">1542</a>         }
<a name="1543" href="#1543">1543</a>         <strong>return</strong> <span class="string">"search:"</span> + type.getName();
<a name="1544" href="#1544">1544</a>     }
<a name="1545" href="#1545">1545</a>     <em>/**<em>*</em></em>
<a name="1546" href="#1546">1546</a> <em>     * Creates all the caches for the current set of persistent types,</em>
<a name="1547" href="#1547">1547</a> <em>     * this should be called in the init for the generic dao being used after persistent classes are loaded</em>
<a name="1548" href="#1548">1548</a> <em>     */</em>
<a name="1549" href="#1549">1549</a>     <strong>protected</strong> <strong>void</strong> initCaches() {
<a name="1550" href="#1550">1550</a>         <strong>for</strong> (Class&lt;?> type : classes) {
<a name="1551" href="#1551">1551</a>             getCacheProvider().createCache(getCacheName(type));
<a name="1552" href="#1552">1552</a>             getCacheProvider().createCache(getSearchCacheName(type));
<a name="1553" href="#1553">1553</a>         }
<a name="1554" href="#1554">1554</a>     }
<a name="1555" href="#1555">1555</a> 
<a name="1556" href="#1556">1556</a>     <em class="comment">// INTERCEPTOR methods</em>
<a name="1557" href="#1557">1557</a> 
<a name="1558" href="#1558">1558</a>     <strong>private</strong> Map&lt;Class&lt;?>, ReadInterceptor> readInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, ReadInterceptor>();
<a name="1559" href="#1559">1559</a>     <strong>private</strong> Map&lt;Class&lt;?>, WriteInterceptor> writeInterceptors = <strong>new</strong> ConcurrentHashMap&lt;Class&lt;?>, WriteInterceptor>();
<a name="1560" href="#1560">1560</a>     <em>/**<em>*</em></em>
<a name="1561" href="#1561">1561</a> <em>     * Adds the provided interceptor to the current set of interceptors</em>
<a name="1562" href="#1562">1562</a> <em>     * @param interceptor</em>
<a name="1563" href="#1563">1563</a> <em>     */</em>
<a name="1564" href="#1564">1564</a>     <strong>public</strong> <strong>void</strong> addInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="1565" href="#1565">1565</a>         <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1566" href="#1566">1566</a>             Class&lt;?> type = interceptor.interceptType();
<a name="1567" href="#1567">1567</a>             <strong>if</strong> (type != <strong>null</strong>) {
<a name="1568" href="#1568">1568</a>                 <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="1569" href="#1569">1569</a>                     readInterceptors.put(type, (ReadInterceptor) interceptor);
<a name="1570" href="#1570">1570</a>                 }
<a name="1571" href="#1571">1571</a>                 <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="1572" href="#1572">1572</a>                     writeInterceptors.put(type, (WriteInterceptor) interceptor);
<a name="1573" href="#1573">1573</a>                 }
<a name="1574" href="#1574">1574</a>             }
<a name="1575" href="#1575">1575</a>         }
<a name="1576" href="#1576">1576</a>     }
<a name="1577" href="#1577">1577</a>     <em>/**<em>*</em></em>
<a name="1578" href="#1578">1578</a> <em>     * Removes the provided interceptor from the current set of interceptors</em>
<a name="1579" href="#1579">1579</a> <em>     * @param interceptor</em>
<a name="1580" href="#1580">1580</a> <em>     */</em>
<a name="1581" href="#1581">1581</a>     <strong>public</strong> <strong>void</strong> removeInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="1582" href="#1582">1582</a>         <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1583" href="#1583">1583</a>             Class&lt;?> type = interceptor.interceptType();
<a name="1584" href="#1584">1584</a>             <strong>if</strong> (type != <strong>null</strong>) {
<a name="1585" href="#1585">1585</a>                 <strong>if</strong> (ReadInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="1586" href="#1586">1586</a>                     readInterceptors.remove(type);
<a name="1587" href="#1587">1587</a>                 }
<a name="1588" href="#1588">1588</a>                 <strong>if</strong> (WriteInterceptor.<strong>class</strong>.isAssignableFrom(interceptor.getClass())) {
<a name="1589" href="#1589">1589</a>                     writeInterceptors.remove(type);
<a name="1590" href="#1590">1590</a>                 }
<a name="1591" href="#1591">1591</a>             }
<a name="1592" href="#1592">1592</a>         }
<a name="1593" href="#1593">1593</a>     }
<a name="1594" href="#1594">1594</a>     <em>/**<em>*</em></em>
<a name="1595" href="#1595">1595</a> <em>     * Makes the given interceptor the only active interceptor,</em>
<a name="1596" href="#1596">1596</a> <em>     * removes all others and adds only this one</em>
<a name="1597" href="#1597">1597</a> <em>     * @param interceptor</em>
<a name="1598" href="#1598">1598</a> <em>     */</em>
<a name="1599" href="#1599">1599</a>     <strong>public</strong> <strong>void</strong> setInterceptor(<a href="../../../../org/sakaiproject/genericdao/api/interceptors/DaoOperationInterceptor.html">DaoOperationInterceptor</a> interceptor) {
<a name="1600" href="#1600">1600</a>         <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1601" href="#1601">1601</a>             readInterceptors.clear();
<a name="1602" href="#1602">1602</a>             writeInterceptors.clear();
<a name="1603" href="#1603">1603</a>             addInterceptor(interceptor);
<a name="1604" href="#1604">1604</a>         }
<a name="1605" href="#1605">1605</a>     }
<a name="1606" href="#1606">1606</a> 
<a name="1607" href="#1607">1607</a>     <strong>protected</strong> <strong>void</strong> beforeRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="1608" href="#1608">1608</a>         <strong>if</strong> (type != <strong>null</strong>) {
<a name="1609" href="#1609">1609</a>             <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="1610" href="#1610">1610</a>             <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1611" href="#1611">1611</a>                 interceptor.beforeRead(operation, ids, search);
<a name="1612" href="#1612">1612</a>             }
<a name="1613" href="#1613">1613</a>         }
<a name="1614" href="#1614">1614</a>     }
<a name="1615" href="#1615">1615</a> 
<a name="1616" href="#1616">1616</a>     <strong>protected</strong> <strong>void</strong> afterRead(String operation, Class&lt;?> type, Serializable[] ids, <a href="../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search, Object[] entities) {
<a name="1617" href="#1617">1617</a>         <strong>if</strong> (type != <strong>null</strong>) {
<a name="1618" href="#1618">1618</a>             <a href="../../../../org/sakaiproject/genericdao/api/interceptors/ReadInterceptor.html">ReadInterceptor</a> interceptor = readInterceptors.get(type);
<a name="1619" href="#1619">1619</a>             <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1620" href="#1620">1620</a>                 interceptor.afterRead(operation, ids, search, entities);
<a name="1621" href="#1621">1621</a>             }
<a name="1622" href="#1622">1622</a>         }
<a name="1623" href="#1623">1623</a>     }
<a name="1624" href="#1624">1624</a> 
<a name="1625" href="#1625">1625</a>     <strong>protected</strong> <strong>void</strong> beforeWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities) {
<a name="1626" href="#1626">1626</a>         <em class="comment">// first handle autocommit</em>
<a name="1627" href="#1627">1627</a>         <strong>if</strong> (isAutoCommitOperations()) {
<a name="1628" href="#1628">1628</a>             commitTransaction();
<a name="1629" href="#1629">1629</a>         }
<a name="1630" href="#1630">1630</a>         <strong>if</strong> (type != <strong>null</strong>) {
<a name="1631" href="#1631">1631</a>             <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="1632" href="#1632">1632</a>             <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1633" href="#1633">1633</a>                 interceptor.beforeWrite(operation, ids, entities);
<a name="1634" href="#1634">1634</a>             }
<a name="1635" href="#1635">1635</a>         }
<a name="1636" href="#1636">1636</a>     }
<a name="1637" href="#1637">1637</a> 
<a name="1638" href="#1638">1638</a>     <strong>protected</strong> <strong>void</strong> afterWrite(String operation, Class&lt;?> type, Serializable[] ids, Object[] entities, <strong>int</strong> changes) {
<a name="1639" href="#1639">1639</a>         <strong>if</strong> (type != <strong>null</strong>) {
<a name="1640" href="#1640">1640</a>             <a href="../../../../org/sakaiproject/genericdao/api/interceptors/WriteInterceptor.html">WriteInterceptor</a> interceptor = writeInterceptors.get(type);
<a name="1641" href="#1641">1641</a>             <strong>if</strong> (interceptor != <strong>null</strong>) {
<a name="1642" href="#1642">1642</a>                 interceptor.afterWrite(operation, ids, entities, changes);
<a name="1643" href="#1643">1643</a>             }
<a name="1644" href="#1644">1644</a>         }
<a name="1645" href="#1645">1645</a>         <em class="comment">// finally handle autocommit</em>
<a name="1646" href="#1646">1646</a>         <strong>if</strong> (isAutoCommitOperations()) {
<a name="1647" href="#1647">1647</a>             commitTransaction();
<a name="1648" href="#1648">1648</a>         }
<a name="1649" href="#1649">1649</a>     }
<a name="1650" href="#1650">1650</a> 
<a name="1651" href="#1651">1651</a>     <em class="comment">// ********* PUBLIC methods ****************</em>
<a name="1652" href="#1652">1652</a> 
<a name="1653" href="#1653">1653</a> 
<a name="1654" href="#1654">1654</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1655" href="#1655">1655</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.GenericDao#getPersistentClasses()</em>
<a name="1656" href="#1656">1656</a> <em class="comment">     */</em>
<a name="1657" href="#1657">1657</a>     <strong>public</strong> List&lt;Class&lt;?>> getPersistentClasses() {
<a name="1658" href="#1658">1658</a>         <strong>return</strong> <strong>new</strong> ArrayList&lt;Class&lt;?>>(classes);
<a name="1659" href="#1659">1659</a>     }
<a name="1660" href="#1660">1660</a> 
<a name="1661" href="#1661">1661</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1662" href="#1662">1662</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.GenericDao#invokeTransactionalAccess(java.lang.Runnable)</em>
<a name="1663" href="#1663">1663</a> <em class="comment">     */</em>
<a name="1664" href="#1664">1664</a>     <strong>public</strong> <strong>void</strong> invokeTransactionalAccess(Runnable toinvoke) {
<a name="1665" href="#1665">1665</a>         toinvoke.run();
<a name="1666" href="#1666">1666</a>     }
<a name="1667" href="#1667">1667</a> 
<a name="1668" href="#1668">1668</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1669" href="#1669">1669</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.GenericDao#findById(java.lang.Class, java.io.Serializable)</em>
<a name="1670" href="#1670">1670</a> <em class="comment">     */</em>
<a name="1671" href="#1671">1671</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="1672" href="#1672">1672</a>     <strong>public</strong> &lt;T> T findById(Class&lt;T> type, Serializable id) {
<a name="1673" href="#1673">1673</a>         checkClass(type);
<a name="1674" href="#1674">1674</a>         <strong>if</strong> (id == <strong>null</strong>) {
<a name="1675" href="#1675">1675</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"id must be set to find persistent object"</span>);
<a name="1676" href="#1676">1676</a>         }
<a name="1677" href="#1677">1677</a> 
<a name="1678" href="#1678">1678</a>         T entity = <strong>null</strong>;
<a name="1679" href="#1679">1679</a>         <em class="comment">// check cache first</em>
<a name="1680" href="#1680">1680</a>         String key = id.toString();
<a name="1681" href="#1681">1681</a>         String cacheName = getCacheName(type);
<a name="1682" href="#1682">1682</a>         <strong>if</strong> (getCacheProvider().exists(cacheName, key)) {
<a name="1683" href="#1683">1683</a>             entity = (T) getCacheProvider().get(cacheName, key);
<a name="1684" href="#1684">1684</a>         } <strong>else</strong> {
<a name="1685" href="#1685">1685</a>             <em class="comment">// not in cache so go to the DB</em>
<a name="1686" href="#1686">1686</a> 
<a name="1687" href="#1687">1687</a>             <em class="comment">// before interceptor</em>
<a name="1688" href="#1688">1688</a>             String operation = <span class="string">"findById"</span>;
<a name="1689" href="#1689">1689</a>             beforeRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="1690" href="#1690">1690</a> 
<a name="1691" href="#1691">1691</a>             entity = baseFindById(type, id);
<a name="1692" href="#1692">1692</a> 
<a name="1693" href="#1693">1693</a>             <em class="comment">// now put the item in the cache</em>
<a name="1694" href="#1694">1694</a>             getCacheProvider().put(cacheName, key, entity);
<a name="1695" href="#1695">1695</a> 
<a name="1696" href="#1696">1696</a>             <em class="comment">// after interceptor</em>
<a name="1697" href="#1697">1697</a>             afterRead(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, <strong>new</strong> Object[] {entity});
<a name="1698" href="#1698">1698</a>         }
<a name="1699" href="#1699">1699</a>         <strong>return</strong> entity;
<a name="1700" href="#1700">1700</a>     }
<a name="1701" href="#1701">1701</a> 
<a name="1702" href="#1702">1702</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1703" href="#1703">1703</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#create(java.lang.Object)</em>
<a name="1704" href="#1704">1704</a> <em class="comment">     */</em>
<a name="1705" href="#1705">1705</a>     <strong>public</strong> <strong>void</strong> create(Object object) {
<a name="1706" href="#1706">1706</a>         Class&lt;?> type = findClass(object);
<a name="1707" href="#1707">1707</a>         checkClass(type);
<a name="1708" href="#1708">1708</a> 
<a name="1709" href="#1709">1709</a>         String operation = <span class="string">"create"</span>;
<a name="1710" href="#1710">1710</a>         beforeWrite(operation, type, <strong>null</strong>, <strong>new</strong> Object[] {object});
<a name="1711" href="#1711">1711</a> 
<a name="1712" href="#1712">1712</a>         Serializable idValue = baseCreate(type, object);
<a name="1713" href="#1713">1713</a> 
<a name="1714" href="#1714">1714</a>         <em class="comment">// clear the search caches</em>
<a name="1715" href="#1715">1715</a>         getCacheProvider().clear(getSearchCacheName(type));
<a name="1716" href="#1716">1716</a> 
<a name="1717" href="#1717">1717</a>         afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="1718" href="#1718">1718</a>     }
<a name="1719" href="#1719">1719</a> 
<a name="1720" href="#1720">1720</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1721" href="#1721">1721</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#update(java.lang.Object)</em>
<a name="1722" href="#1722">1722</a> <em class="comment">     */</em>
<a name="1723" href="#1723">1723</a>     <strong>public</strong> <strong>void</strong> update(Object object) {
<a name="1724" href="#1724">1724</a>         Class&lt;?> type = findClass(object);
<a name="1725" href="#1725">1725</a>         checkClass(type);
<a name="1726" href="#1726">1726</a> 
<a name="1727" href="#1727">1727</a>         Serializable idValue = baseGetIdValue(object);
<a name="1728" href="#1728">1728</a>         <strong>if</strong> (idValue == <strong>null</strong>) {
<a name="1729" href="#1729">1729</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Could not get an id value from the supplied object, cannot update without an id: "</span> + object);
<a name="1730" href="#1730">1730</a>         }
<a name="1731" href="#1731">1731</a> 
<a name="1732" href="#1732">1732</a>         String operation = <span class="string">"update"</span>;
<a name="1733" href="#1733">1733</a>         beforeWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object});
<a name="1734" href="#1734">1734</a> 
<a name="1735" href="#1735">1735</a>         baseUpdate(type, idValue, object);
<a name="1736" href="#1736">1736</a> 
<a name="1737" href="#1737">1737</a>         <em class="comment">// clear the search caches</em>
<a name="1738" href="#1738">1738</a>         getCacheProvider().clear(getSearchCacheName(type));
<a name="1739" href="#1739">1739</a>         <em class="comment">// clear the cache entry since this was updated</em>
<a name="1740" href="#1740">1740</a>         String key = idValue.toString();
<a name="1741" href="#1741">1741</a>         String cacheName = getCacheName(type);
<a name="1742" href="#1742">1742</a>         getCacheProvider().remove(cacheName, key);
<a name="1743" href="#1743">1743</a> 
<a name="1744" href="#1744">1744</a>         afterWrite(operation, type, <strong>new</strong> Serializable[] {idValue}, <strong>new</strong> Object[] {object}, 1);
<a name="1745" href="#1745">1745</a>     }
<a name="1746" href="#1746">1746</a> 
<a name="1747" href="#1747">1747</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1748" href="#1748">1748</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#save(java.lang.Object)</em>
<a name="1749" href="#1749">1749</a> <em class="comment">     */</em>
<a name="1750" href="#1750">1750</a>     <strong>public</strong> <strong>void</strong> save(Object object) {
<a name="1751" href="#1751">1751</a>         Serializable id = baseGetIdValue(object);
<a name="1752" href="#1752">1752</a>         <strong>if</strong> (id == <strong>null</strong>) {
<a name="1753" href="#1753">1753</a>             create(object);
<a name="1754" href="#1754">1754</a>         } <strong>else</strong> {
<a name="1755" href="#1755">1755</a>             update(object);
<a name="1756" href="#1756">1756</a>         }
<a name="1757" href="#1757">1757</a>     }
<a name="1758" href="#1758">1758</a> 
<a name="1759" href="#1759">1759</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1760" href="#1760">1760</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Object)</em>
<a name="1761" href="#1761">1761</a> <em class="comment">     */</em>
<a name="1762" href="#1762">1762</a>     <strong>public</strong> <strong>void</strong> delete(Object object) {
<a name="1763" href="#1763">1763</a>         Class&lt;?> type = findClass(object);
<a name="1764" href="#1764">1764</a>         Serializable id = baseGetIdValue(object);
<a name="1765" href="#1765">1765</a>         delete(type, id);
<a name="1766" href="#1766">1766</a>     }
<a name="1767" href="#1767">1767</a> 
<a name="1768" href="#1768">1768</a>     <em class="comment">/*<em class="comment"> (non-Javadoc)</em></em>
<a name="1769" href="#1769">1769</a> <em class="comment">     * @see org.sakaiproject.genericdao.api.modifiers.BasicModifier#delete(java.lang.Class, java.io.Serializable)</em>
<a name="1770" href="#1770">1770</a> <em class="comment">     */</em>
<a name="1771" href="#1771">1771</a>     <strong>public</strong> &lt;T> <strong>boolean</strong> delete(Class&lt;T> type, Serializable id) {
<a name="1772" href="#1772">1772</a>         checkClass(type);
<a name="1773" href="#1773">1773</a> 
<a name="1774" href="#1774">1774</a>         String operation = <span class="string">"delete"</span>;
<a name="1775" href="#1775">1775</a>         beforeWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>);
<a name="1776" href="#1776">1776</a> 
<a name="1777" href="#1777">1777</a>         <strong>boolean</strong> removed = baseDelete(type, id);
<a name="1778" href="#1778">1778</a> 
<a name="1779" href="#1779">1779</a>         <strong>if</strong> (removed) {
<a name="1780" href="#1780">1780</a>             <em class="comment">// clear the search caches</em>
<a name="1781" href="#1781">1781</a>             getCacheProvider().clear(getSearchCacheName(type));
<a name="1782" href="#1782">1782</a>             <em class="comment">// clear this from the cache</em>
<a name="1783" href="#1783">1783</a>             String key = id.toString();
<a name="1784" href="#1784">1784</a>             String cacheName = getCacheName(type);
<a name="1785" href="#1785">1785</a>             getCacheProvider().remove(cacheName, key);
<a name="1786" href="#1786">1786</a> 
<a name="1787" href="#1787">1787</a>             afterWrite(operation, type, <strong>new</strong> Serializable[] {id}, <strong>null</strong>, 1);
<a name="1788" href="#1788">1788</a>         }
<a name="1789" href="#1789">1789</a>         <strong>return</strong> removed;
<a name="1790" href="#1790">1790</a>     }
<a name="1791" href="#1791">1791</a> 
<a name="1792" href="#1792">1792</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

